Skip to main content

Little api client for paperless(-ngx).

Project description

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

Project details


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.2.tar.gz (25.9 kB view hashes)

Uploaded Source

Built Distribution

pypaperless-3.1.2-py3-none-any.whl (38.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page