Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/totaldebug/asyncpow

Asynchronous Python Overseerr Wrapper
https://github.com/totaldebug/asyncpow

overseerr python wrapper-api

Last synced: 9 days ago
JSON representation

Asynchronous Python Overseerr Wrapper

Awesome Lists containing this project

README

        

[![Release][release-shield]][release-url]
[![Stargazers][stars-shield]][stars-url]
![codecov][codecov-shield]

![GitHub last release date][gh-last-release-date]
![GitHub last commit][gh-last-commit]

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]

[![Lines of code][lines]][lines-url]
![Code size][code-size]

[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]





Logo

AsyncPOW


Python Overseerr Wrapper, A Python library for interacting with the Overseerr API's






Report Bug
·
Request Feature

Table of Contents



  1. About The Project


  2. Getting Started

  3. Features

  4. Compatibility

  5. Roadmap

  6. Sponsor

  7. Contributing

  8. License

  9. Contact

  10. Acknowledgments

## About The Project

This project is a work in progress, the main branch is being developed on live, which may cause breaking changes until the first full release.

The library returns results in JSON format for ease of use, this also reduces the risk of failue when the APIs are updated.

Type hints and type models are in place where possible (this API has terrible circular dependencies which breaks python), if you notice missing items please create a request to have it fixed.

(back to top)

### Built With

[![python][python]][python-url]

(back to top)

## Getting Started

* [QuickStart Guide](https://docs.totaldebug.uk/asyncpow/quickstart.html)
* [Full Documentation](https://docs.totaldebug.uk/asyncpow)
* [Release Notes](https://github.com/totaldebug/asyncpow/releases)

(back to top)

## Features

* Asynchronous
* Type Checking
* Status - Completed
* Discover - WIP
* Trending - Completed
* Media - WIP
* Get - Completed
* Update Status - Completed
* Delete
* Get Watch Data
* User - WIP
* Get - Completed
* Bulk Update - Completed
* Update
* Delete

## Compatibility

AsyncPOW is built for Python 3.12, and initially the v1 Overseerr API

(back to top)

## Roadmap

See the [feature requests](https://github.com/totaldebug/asyncpow/labels/type%2Ffeature) for a full list of requested features.

(back to top)

## Sponsor

My projects arent possible without the support of the community, please consider donating a small amount to keep these projects alive.

[![Sponsor][Sponsor]][Sponsor-url]

## Contributing

Got something you would like to add? check out the contributing guide in the [documentation](https://docs.totaldebug.uk/asyncpow/contributing.html)

(back to top)

## License

[![CC BY-NC-SA 4.0][license-shield]][license-url]

* Copyright © [Total Debug](https://totaldebug.uk).

(back to top)

## Contact

* [Discord](https://discord.gg/6fmekudc8Q)
* [Discussions](https://github.com/totaldebug/asyncpow/discussions)
* [Project Link](https://github.com/totaldebug/asyncpow)

(back to top)

## Acknowledgments

Below are a list of resources that I used to assist with this project.

* None at this time

(back to top)

[release-shield]: https://img.shields.io/github/v/release/totaldebug/asyncpow?color=ff7034&label=Release&sort=semver&style=flat-square
[release-url]: https://github.com/totaldebug/asyncpow/releases
[contributors-shield]: https://img.shields.io/github/contributors/totaldebug/asyncpow.svg?style=flat-square
[contributors-url]: https://github.com/totaldebug/asyncpow/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/totaldebug/asyncpow.svg?style=flat-square
[forks-url]: https://github.com/totaldebug/asyncpow/network/members
[stars-shield]: https://img.shields.io/github/stars/totaldebug/asyncpow.svg?style=flat-square
[stars-url]: https://github.com/totaldebug/asyncpow/stargazers
[issues-shield]: https://img.shields.io/github/issues/totaldebug/asyncpow.svg?style=flat-square
[issues-url]: https://github.com/totaldebug/asyncpow/issues
[license-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-orange.svg?style=flat-square
[license-url]: https://creativecommons.org/licenses/by-nc-sa/4.0/
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/marksie1988
[codecov-shield]: https://img.shields.io/codecov/c/github/totaldebug/asyncpow?style=flat-square

[gh-last-release-date]: https://img.shields.io/github/release-date/totaldebug/asyncpow?style=flat-square&label=Last%20Release%20Date&logo=github&logoColor=white
[gh-last-commit]: https://img.shields.io/github/last-commit/totaldebug/asyncpow.svg?style=flat-square&logo=github&label=Last%20Commit&logoColor=white

[lines]: https://img.shields.io/tokei/lines/github/totaldebug/asyncpow?style=flat-square
[lines-url]: https://github.com/totaldebug/asyncpow
[code-size]: https://img.shields.io/github/languages/code-size/totaldebug/asyncpow?style=flat-square

[Sponsor]: https://img.shields.io/badge/sponsor-000?style=flat-square&logo=githubsponsors&logoColor=red
[Sponsor-url]: https://github.com/sponsors/marksie1988

[python]: https://img.shields.io/badge/Python-blue?style=flat-square&logo=Python&logoColor=white
[python-url]: https://www.python.org/