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.3.tar.gz
(25.9 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.1.3.tar.gz
.
File metadata
- Download URL: pypaperless-3.1.3.tar.gz
- Upload date:
- Size: 25.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a44fdf1e8ae72fe1db4218bc7afe2f6008ec39e848ce9e15d1880060d3930b9e |
|
MD5 | 950cb56e999ac763422dd27aea7ba25a |
|
BLAKE2b-256 | 5ecec6d271e20c857cf40ee26bc3a3b6806efba583970a319e53373ee6384d78 |
Provenance
File details
Details for the file pypaperless-3.1.3-py3-none-any.whl
.
File metadata
- Download URL: pypaperless-3.1.3-py3-none-any.whl
- Upload date:
- Size: 38.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff5654ccaffc231910d27d80fd68644ac58b40fb0436b0662857dee089f7d2ee |
|
MD5 | dcc84d79f350cbca8b7a40cd1d5f17b8 |
|
BLAKE2b-256 | 6356a433209cc236c05259e7897e77d18d93eb0f31c049c5cbab82644a972e7a |