Skip to content

Add comprehensive documentation for PyLoadAPI usage#31

Merged
tr4nt0r merged 1 commit intomainfrom
usage_page
Jun 15, 2024
Merged

Add comprehensive documentation for PyLoadAPI usage#31
tr4nt0r merged 1 commit intomainfrom
usage_page

Conversation

@tr4nt0r
Copy link
Owner

@tr4nt0r tr4nt0r commented Jun 15, 2024

  • Introduced a new documentation page outlining the usage of the PyLoadAPI class.
  • Included instructions for importing necessary modules.
  • Provided detailed examples for logging configuration, creating an instance of PyLoadAPI, and performing various operations such as login, getting status, pausing/unpausing downloads, toggling pause, stopping all downloads, restarting failed downloads, toggling reconnect, deleting finished files, restarting PyLoad core, getting version, and checking free space.
  • Documented exception handling for CannotConnect, InvalidAuth, and ParserError.
  • Included example code for setting logging to debug mode and using asyncio.

- Introduced a new documentation page outlining the usage of the PyLoadAPI class.
- Included instructions for importing necessary modules.
- Provided detailed examples for logging configuration, creating an instance of PyLoadAPI, and performing various operations such as login, getting status, pausing/unpausing downloads, toggling pause, stopping all downloads, restarting failed downloads, toggling reconnect, deleting finished files, restarting PyLoad core, getting version, and checking free space.
- Documented exception handling for CannotConnect, InvalidAuth, and ParserError.
- Included example code for setting logging to debug mode and using asyncio.
@codecov
Copy link

codecov bot commented Jun 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.83%. Comparing base (243acc2) to head (c4a557b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #31   +/-   ##
=======================================
  Coverage   96.83%   96.83%           
=======================================
  Files           4        4           
  Lines         158      158           
=======================================
  Hits          153      153           
  Misses          5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tr4nt0r tr4nt0r merged commit 3c7a268 into main Jun 15, 2024
@tr4nt0r tr4nt0r deleted the usage_page branch June 15, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant