Little api client for paperless(-ngx).


Keywords
library, async, api-client, python3, paperless-ngx
License
MIT
Install
pip install pypaperless==3.1.14

Documentation

PyPaperless

GitHub Release Python Version GitHub License

Tests Codecov Linting Typing

Little asynchronous client for Paperless-ngx, written in Python. You should at least use Python >=3.11.

Find out more about Paperless-ngx here:

Features

  • Depends on aiohttp, works in async environments.
  • Token authentication only. No credentials anymore.
  • Request single resource items.
  • Iterate over all resource items or request them page by page.
  • Create, update and delete resource items.
  • Almost feature complete.
  • PyPaperless is designed to transport data only. Your code must organize it.

Installation

pip install pypaperless

Documentation

Please check out the docs for detailed instructions and examples.

Authors & contributors

PyPaperless is written by Tobias Schulz. Its his first Python project. Feedback appreciated.

Check out all contributors here.

Thanks to

  • The Paperless-ngx Team
  • The Home Assistant Community