PyPaperless

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

v4 upgrade warning

• We dropped support for Python <=3.11.
• Major changes in various classes occurred. Consider using Paperless-ngx >=2.15.0.
• Support for Paperless-ngx <2.15.0 will end after 2025/07.

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.

Find out more about Paperless-ngx here:

• Project: https://docs.paperless-ngx.com
• API Docs: https://docs.paperless-ngx.com/api/
• Source Code: https://github.com/paperless-ngx/paperless-ngx

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.