Little api client for paperless(-ngx).
Project description
PyPaperless
Little asynchronous client for Paperless-ngx, written in Python. You should at least use Python >=3.11
.
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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pypaperless-3.1.15.tar.gz
(26.3 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.1.15.tar.gz
.
File metadata
- Download URL: pypaperless-3.1.15.tar.gz
- Upload date:
- Size: 26.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44e3c32d91eac57c02daeeaaa2c3ff04cc3fba37aee02434d396b863afb92750 |
|
MD5 | ed386e3c9d7979a592a51e86e80bb061 |
|
BLAKE2b-256 | 362a21756621ffa1e7a79f5a766055a02eba9a4128010d3dfb381fd04ad0bfd4 |
File details
Details for the file pypaperless-3.1.15-py3-none-any.whl
.
File metadata
- Download URL: pypaperless-3.1.15-py3-none-any.whl
- Upload date:
- Size: 39.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f80c71f6ed13e86c21bfa3a3ddbd094e7fe64f9597ec29a3966d1f0ebfa862fb |
|
MD5 | 274b1d568016bea1953b7c9d72357cee |
|
BLAKE2b-256 | b3adee6d5a0f57568393b21dd6225769d1c2c8e3ab426d9c0e97cebf550e42d6 |