Little api client for paperless(-ngx).

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbsch from gravatar.com tbsch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Tobias Schulz
  • Tags api-client , async , library , paperless-ngx , python3
  • Requires: Python <3.15, >=3.12
Classifiers
Report project as malware

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.12.

Features

  • Depends on aiohttp, works in async environments.
  • Token authentication preferred (credentials possible using a URL like https://user:pass@example.com)
  • Request single resource items.
  • Iterate over all resource items or request them page by page.
  • Create, update and delete resource items.
  • Add, remove and update custom fields on documents.
  • Almost feature complete.
  • pypaperless is designed to transport data only. Your code must organize it.

Find out more about Paperless-ngx here:

Installation

pip install pypaperless

Documentation

Please check out the docs for detailed instructions and examples.

Compatibility matrix

Choosing the right version of pypaperless for your Paperless-ngx instance can be tricky. This little matrix is here to help.

pypaperless Paperless-ngx
>= 5.2 >= 2.19
>= 5.1 >= 2.17
>= 5.0 >= 2.17
>= 4.1 >= 2.16
>= 4.0 >= 2.15
< 4.0 < 2.15
  • pypaperless <4.0 is not compatible with Paperless-ngx >=2.15 due to breaking server changes.
  • pypaperless >=5.0 implements date changes in the document API and is therefore not compatible with Paperless-ngx <2.17.
  • pypaperless >=5.1 will drop support for all Paperless-ngx versions without the Open API schema, introduced in 2.15.
  • pypaperless >=5.2 utilizes API models and data which is available as of Paperless-ngx >=2.19.

Consider keeping both Paperless-ngx and pypaperless always updated.

Authors & contributors

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

Check out all contributors here.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbsch from gravatar.com tbsch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Tobias Schulz
  • Tags api-client , async , library , paperless-ngx , python3
  • Requires: Python <3.15, >=3.12
Classifiers

Release history Release notifications | RSS feed

This version

5.2.2

5.2.1

5.2.0

5.1.0

5.0.0

4.1.2

4.1.1

4.1.0

4.0.0

3.1.15

3.1.14

3.1.13

3.1.12

3.1.11

3.1.10

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.2

3.0.1

3.0.0

2.4.0

2.3.0

2.2.1

2.2.0

2.1.0

2.0.1

1.1.0

1.0.0

0.0.8

0.0.7

0.0.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypaperless-5.2.2.tar.gz (163.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pypaperless-5.2.2-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

Details for the file pypaperless-5.2.2.tar.gz.

File metadata

  • Download URL: pypaperless-5.2.2.tar.gz
  • Upload date:
  • Size: 163.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pypaperless-5.2.2.tar.gz
Algorithm Hash digest
SHA256 a3cc1e2d2d8a4689cd8d33a98474b2af65c7d9b9724e26f2f15f97f8c6d99c52
MD5 f7e8f49bc56bb77eb66b1a644c1b714b
BLAKE2b-256 ac4ae327b719ff11e8c424fa58b7bd5a9fdec7b9f03a910311a8a8ee4be0ca52

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypaperless-5.2.2.tar.gz:

Publisher: release.yml on tb1337/paperless-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypaperless-5.2.2-py3-none-any.whl.

File metadata

  • Download URL: pypaperless-5.2.2-py3-none-any.whl
  • Upload date:
  • Size: 45.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pypaperless-5.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 42457f936dde0a72cd3ed23ae3252a280e2e0e2249c8782f3a9e8c08361c1f60
MD5 f0d4a67e8b0f1dc40906ff49ef22b833
BLAKE2b-256 113232a55895f2b2679692c552a8dc3614d6fd39ec7207f68d7bef253e303311

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypaperless-5.2.2-py3-none-any.whl:

Publisher: release.yml on tb1337/paperless-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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