{"id":37080570,"url":"https://github.com/tb1337/paperless-api","last_synced_at":"2026-01-14T09:46:52.695Z","repository":{"id":59150068,"uuid":"477577963","full_name":"tb1337/paperless-api","owner":"tb1337","description":"Little api client for paperless(-ngx): pypaperless","archived":false,"fork":false,"pushed_at":"2026-01-05T02:51:15.000Z","size":2055,"stargazers_count":83,"open_issues_count":2,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-05T10:59:04.558Z","etag":null,"topics":["api-client","async","library","paperless-ngx","python3"],"latest_commit_sha":null,"homepage":"https://pypi.org/p/pypaperless/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tb1337.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-04-04T06:36:04.000Z","updated_at":"2026-01-03T22:24:36.000Z","dependencies_parsed_at":"2023-12-16T08:38:48.455Z","dependency_job_id":"378016be-d710-4c15-8b3e-20a8103466be","html_url":"https://github.com/tb1337/paperless-api","commit_stats":null,"previous_names":["grdn1337/paperless-api"],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/tb1337/paperless-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tb1337%2Fpaperless-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tb1337%2Fpaperless-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tb1337%2Fpaperless-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tb1337%2Fpaperless-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tb1337","download_url":"https://codeload.github.com/tb1337/paperless-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tb1337%2Fpaperless-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28416120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","async","library","paperless-ngx","python3"],"created_at":"2026-01-14T09:46:52.097Z","updated_at":"2026-01-14T09:46:52.683Z","avatar_url":"https://github.com/tb1337.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyPaperless\n\n[![GitHub Release][release-badge]][release-url]\n[![Python Version][python-badge]][python-url]\n[![GitHub License][license-badge]][license-url]\n\n[![Tests][tests-badge]][tests-url]\n[![Codecov][codecov-badge]][codecov-url]\n[![Linting][linting-badge]][linting-url]\n[![Typing][typing-badge]][typing-url]\n\nLittle asynchronous client for *Paperless-ngx*, written in Python. You should at least use Python `\u003e=3.12`.\n\n## Features\n\n- Depends on aiohttp, works in async environments.\n- Token authentication preferred (credentials possible using a URL like https://user:pass@example.com)\n- Request single resource items.\n- Iterate over all resource items or request them page by page.\n- Create, update and delete resource items.\n- Add, remove and update custom fields on documents.\n- Almost feature complete.\n- **pypaperless** is designed to transport data only. Your code must organize it.\n\nFind out more about *Paperless-ngx* here:\n\n- Project: https://docs.paperless-ngx.com\n- API Docs: https://docs.paperless-ngx.com/api/\n- Source Code: https://github.com/paperless-ngx/paperless-ngx\n\n## Installation\n\n```bash\npip install pypaperless\n```\n\n## Documentation\n\nPlease check out the **[docs][docs-url]** for detailed instructions and examples.\n\n## Compatibility matrix\n\nChoosing the right version of **pypaperless** for your *Paperless-ngx* instance can be tricky. This little matrix is here to help.\n\n| **pypaperless** | *Paperless-ngx* |\n| --------------- | --------------- |\n| \u003e= 5.2          | \u003e= 2.19         |\n| \u003e= 5.1          | \u003e= 2.17         |\n| \u003e= 5.0          | \u003e= 2.17         |\n| \u003e= 4.1          | \u003e= 2.16         |\n| \u003e= 4.0          | \u003e= 2.15         |\n| \u003c 4.0           | \u003c 2.15          |\n\n* **pypaperless** `\u003c4.0` is not compatible with *Paperless-ngx* `\u003e=2.15` due to breaking server changes.\n* **pypaperless** `\u003e=5.0` implements date changes in the document API and is therefore not compatible with *Paperless-ngx* `\u003c2.17`.\n* **pypaperless** `\u003e=5.1` will drop support for all *Paperless-ngx* versions without the Open API schema, introduced in `2.15`.\n* **pypaperless** `\u003e=5.2` utilizes API models and data which is available as of *Paperless-ngx* `\u003e=2.19`.\n\nConsider keeping both *Paperless-ngx* and **pypaperless** always updated.\n\n## Authors \u0026 contributors\n\n**pypaperless** is written by [Tobias Schulz][contributors-tbsch]. Its his first Python project. Feedback appreciated.\n\nCheck out all [contributors here][contributors-url].\n\n[codecov-badge]: https://codecov.io/gh/tb1337/paperless-api/graph/badge.svg?token=IMXRBK3HRE\n[codecov-url]: https://app.codecov.io/gh/tb1337/paperless-api/tree/main\n[contributors-tbsch]: https://tbsch.de\n[contributors-url]: https://github.com/tb1337/paperless-api/graphs/contributors\n[docs-url]: https://github.com/tb1337/paperless-api/blob/main/docs/\n[license-badge]: https://img.shields.io/github/license/tb1337/paperless-api\n[license-url]: /LICENSE.md\n[python-badge]: https://img.shields.io/pypi/pyversions/pypaperless\n[python-url]: https://pypi.org/project/pypaperless/\n[tests-badge]: https://github.com/tb1337/paperless-api/actions/workflows/tests.yml/badge.svg\n[tests-url]: https://github.com/tb1337/paperless-api/actions\n[release-badge]: https://img.shields.io/github/v/release/tb1337/paperless-api\n[release-url]: https://github.com/tb1337/paperless-api/releases\n[linting-badge]: https://github.com/tb1337/paperless-api/actions/workflows/linting.yml/badge.svg\n[linting-url]: https://github.com/tb1337/paperless-api/actions\n[typing-badge]: https://github.com/tb1337/paperless-api/actions/workflows/typing.yml/badge.svg\n[typing-url]: https://github.com/tb1337/paperless-api/actions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftb1337%2Fpaperless-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftb1337%2Fpaperless-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftb1337%2Fpaperless-api/lists"}