pypaperless-cli2 0.1.0__tar.gz → 0.2.1__tar.gz

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypaperless-cli2
-Version: 0.1.0
+Version: 0.2.1
 Summary: Command-line interface for Paperless-ngx (fork of pypaperless-cli, updated for pypaperless 5.x / Paperless-ngx 3.x)
 License-File: LICENSE
 Author: Marcel Brückner
@@ -24,16 +24,14 @@ Description-Content-Type: text/markdown
 
 Paperless-ngx Command-Line Interface
 
-This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli), republished as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`). The `pngx` command and all usage below are unchanged from upstream.
+This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli).
 
-I've recently started a project to collect scripts around Paperless-ngx ([paperless.sh](https://paperless.sh)). It turned out - surprise - to be very tedious to write a separate [script](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/post-consumption/content-matching/pngx-update-document.py) [each](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum.py) [time](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum-of-differences.py) I need to work with Paperless-ngx's API.
-I was looking for a way to easily update certain fields of my documents but without the overhead of "manually" calling API endpoints each time.
-I wrapped things in simple python scripts which eventually became this tool which essentially ~~is~~ will become Paperless-ngx at your command-line.
+After updating my Paperless-ngx instances to version 3.x the current pypaperless-cli package has thrown some errors when editing documents.
+I republished the current pypaperless-cli as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`).
+The `pngx` command and all usage below are unchanged from upstream.
 
 ## Usage
 
-This very first public release currently only allows you to retrieve information or update certain fields of your existing documents (with more to come in the future).
-
 ```bash
 # Run pngx -h for help
 $ pngx [ command ] [ subcommand ] [ arguments and parameters ]
@@ -67,6 +65,16 @@ Update a document's title and correspondent.
 $ pngx document edit <ID> --title "My new document title" --correspondent <CORRESPONDENT_ID>
 ```
 
+Update a document's creation date.
+
+The Paperless-ngx API expects the date in ISO 8601 format. With Version 0.2.0 of this package comes a dateparser which auto-detects the used date format and converts it to ISO 8601 format.
+
+```bash
+# Set document creation date to "14.09.2026"
+$ pngx document edit <ID> --created-date 14.09.2026
+# The date parser automatically converts the date to 2026-09-14 and uses it in the communication with the API
+```
+
 Assign or unassign a document's tags.
 
 Tags can be specified by ID or the *exact* name. If your tag name contains spaces, wrap it in quotes.

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/README.md

@@ -2,16 +2,14 @@
 
 Paperless-ngx Command-Line Interface
 
-This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli), republished as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`). The `pngx` command and all usage below are unchanged from upstream.
+This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli).
 
-I've recently started a project to collect scripts around Paperless-ngx ([paperless.sh](https://paperless.sh)). It turned out - surprise - to be very tedious to write a separate [script](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/post-consumption/content-matching/pngx-update-document.py) [each](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum.py) [time](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum-of-differences.py) I need to work with Paperless-ngx's API.
-I was looking for a way to easily update certain fields of my documents but without the overhead of "manually" calling API endpoints each time.
-I wrapped things in simple python scripts which eventually became this tool which essentially ~~is~~ will become Paperless-ngx at your command-line.
+After updating my Paperless-ngx instances to version 3.x the current pypaperless-cli package has thrown some errors when editing documents.
+I republished the current pypaperless-cli as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`).
+The `pngx` command and all usage below are unchanged from upstream.
 
 ## Usage
 
-This very first public release currently only allows you to retrieve information or update certain fields of your existing documents (with more to come in the future).
-
 ```bash
 # Run pngx -h for help
 $ pngx [ command ] [ subcommand ] [ arguments and parameters ]
@@ -45,6 +43,16 @@ Update a document's title and correspondent.
 $ pngx document edit <ID> --title "My new document title" --correspondent <CORRESPONDENT_ID>
 ```
 
+Update a document's creation date.
+
+The Paperless-ngx API expects the date in ISO 8601 format. With Version 0.2.0 of this package comes a dateparser which auto-detects the used date format and converts it to ISO 8601 format.
+
+```bash
+# Set document creation date to "14.09.2026"
+$ pngx document edit <ID> --created-date 14.09.2026
+# The date parser automatically converts the date to 2026-09-14 and uses it in the communication with the API
+```
+
 Assign or unassign a document's tags.
 
 Tags can be specified by ID or the *exact* name. If your tag name contains spaces, wrap it in quotes.

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pypaperless-cli2"
-version = "0.1.0"
+version = "0.2.1"
 description = "Command-line interface for Paperless-ngx (fork of pypaperless-cli, updated for pypaperless 5.x / Paperless-ngx 3.x)"
 authors = ["Marcel Brückner <marcelbrueckner@users.noreply.github.com>"]
 readme = "README.md"

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/src/pypaperless_cli/commands/document/edit.py

@@ -8,7 +8,7 @@ from pypaperless.models.common import CustomFieldValue
 
 from pypaperless_cli.api import PaperlessAsyncAPI
 from pypaperless_cli.utils import converters, groups, validators
-from pypaperless_cli.utils.types import CustomFieldKeyValue, Document
+from pypaperless_cli.utils.types import CustomFieldKeyValue, Date, Document
 
 group_tags = Group(name = "Tags parameters", sort_key=groups.standard_fields.sort_key+1)
 group_custom_fields = Group(name = "Custom fields parameters", sort_key=group_tags.sort_key+1)
@@ -21,7 +21,7 @@ async def edit(
     document_type: Optional[int] = None,
     storage_path: Optional[int] = None,
     title: Optional[str] = None,
-    created_date: Optional[str] = None,
+    created_date: Optional[Date] = None,
     
     # Handle tags
     add_tags: Annotated[
@@ -86,7 +86,8 @@ async def edit(
     title: str
         Document title
     created_date: str
-        The ISO 8601 date (YYYY-MM-DD) the document was initially issued.
+        The date the document was initially issued. Accepts several formats, e.g. YYYY-MM-DD
+        (ISO 8601) or DD.MM.YYYY (German), and normalizes them automatically.
 
     add_tags: List[str|int]
         Assign tags. Requires the ID or the exact name of the tags.
@@ -121,8 +122,7 @@ async def edit(
             document.title = title
         
         if created_date:
-            from datetime import datetime
-            document.created = datetime.strptime(created_date, "%Y-%m-%d").date()
+            document.created = created_date
 
         if remove_tags:
             # Only keep tags not in `remove_tags``

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/src/pypaperless_cli/utils/converters/__init__.py

@@ -4,6 +4,7 @@ from typing import Any
 
 
 from pypaperless_cli.utils.converters.custom_field import custom_field_name_to_id
+from pypaperless_cli.utils.converters.date import parse_date
 from pypaperless_cli.utils.converters.tag import tag_name_to_id
 
 import pypaperless_cli.utils.converters.helpers

pypaperless_cli2-0.2.1/src/pypaperless_cli/utils/converters/date.py

@@ -0,0 +1,29 @@
+"""Date related converter"""
+
+from typing import Any
+
+import arrow
+
+# Formats are tried in order until one matches; the first match wins.
+# Day-first is assumed for dot/slash-separated dates (e.g. German invoices use DD.MM.YYYY),
+# so MM/DD/YYYY-style US dates are deliberately not included to avoid ambiguity.
+SUPPORTED_DATE_FORMATS = [
+    "YYYY-MM-DD",
+    "DD.MM.YYYY",
+    "DD.MM.YY",
+    "DD/MM/YYYY",
+    "YYYY/MM/DD",
+]
+
+def parse_date(type_, *args) -> Any:
+    """Parses a date given in any of `SUPPORTED_DATE_FORMATS` into a `date` object."""
+
+    value = args[0]
+
+    try:
+        return arrow.get(value, SUPPORTED_DATE_FORMATS).date()
+    except arrow.parser.ParserError:
+        raise ValueError(
+            f"\"{value}\" is not a recognized date. Supported formats: "
+            + ", ".join(SUPPORTED_DATE_FORMATS)
+        )

{pypaperless_cli2-0.1.0 → pypaperless_cli2-0.2.1}/src/pypaperless_cli/utils/types.py

@@ -1,5 +1,6 @@
 """Custom variable types."""
 
+from datetime import date
 from typing import Annotated
 
 from cyclopts import Parameter
@@ -21,6 +22,10 @@ Document = Annotated[int, Parameter(
     validator = validators.document_exists
     )]
 
+Date = Annotated[date, Parameter(
+    converter = converters.parse_date
+    )]
+
 CustomFieldKeyValue = Annotated[str|int, Parameter(
     converter = converters.custom_field_name_to_id,
     validator = validators.custom_field_exists