Skip to content

PyLoadAPI

Simple wrapper for pyLoad's API.

This module provides a simplified interface (PyLoadAPI class) to interact with pyLoad's API using aiohttp for asynchronous HTTP requests. It handles login authentication and provides methods to perform various operations such as pausing downloads, restarting pyLoad, retrieving status information, and more.

build codecov PyPI version "Buy Me A Coffee" GitHub Sponsor


📖 Documentation


📦 Installation

You can install PyLoadAPI via pip:

pip install PyLoadAPI

🚀 Usage

Basic Example

import asyncio
from pyloadapi import PyLoadAPI

async def main():
    async with PyLoadAPI("http://localhost:8000", "username", "password") as api:
        status = await api.status()
        print(status)

asyncio.run(main())

More Examples

Pause Downloads
await api.pause(True)  # Pause all downloads
Resume Downloads
await api.pause(False)  # Resume all downloads
Restart pyLoad
await api.restart()

For more advanced usage, refer to the documentation.


🛠 Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Submit a pull request.

Make sure to follow the contributing guidelines.


📜 License

This project is licensed under the MIT License - see the LICENSE file for details.


❤️ Support

If you find this project useful, consider buying me a coffee ☕ or sponsoring me on GitHub!