pathtmpl

Name	pathtmpl JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	Path Template
upload_time	2024-11-24 07:14:14
maintainer	None
docs_url	None
author	Eugen Ciur
requires_python	<4.0,>=3.13
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Path Template

## Install

```shell
poetry add pathtmpl
```


## Usage

```python
import uuid
from pathlib import PurePath
from datetime import date as Date
from pathtmpl import DocumentContext, CField, get_evaluated_path


path_tmpl = """
{% if document.cf['Effective Date'] %}
    /home/Tax/{{ document.cf['Effective Date'] | datefmt("%Y") }}.pdf
{% else %}
    /home/Tax/{{ document.id }}.pdf
{% endif %}
"""
custom_fields = [
    CField(name="Total", value=245.02),
    CField(name="Effective Date", value=Date(2024, 12, 23)),
]
doc = DocumentContext(
    id=uuid.uuid4(),
    title="coco",
    custom_fields=custom_fields,
)

ev_path = get_evaluated_path(doc, path_template=path_tmpl)
assert ev_path == PurePath("/home/Tax/2024.pdf")
```

## Tests


```shell
poetry run pytest
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pathtmpl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.13",
    "maintainer_email": null,
    "keywords": null,
    "author": "Eugen Ciur",
    "author_email": "eugen@papermerge.com",
    "download_url": "https://files.pythonhosted.org/packages/59/82/ec92816b1fe19fa4cab5c314f0ec8fca5e227ca0f626bde86fe3b2fde63f/pathtmpl-0.2.0.tar.gz",
    "platform": null,
    "description": "# Path Template\n\n## Install\n\n```shell\npoetry add pathtmpl\n```\n\n\n## Usage\n\n```python\nimport uuid\nfrom pathlib import PurePath\nfrom datetime import date as Date\nfrom pathtmpl import DocumentContext, CField, get_evaluated_path\n\n\npath_tmpl = \"\"\"\n{% if document.cf['Effective Date'] %}\n    /home/Tax/{{ document.cf['Effective Date'] | datefmt(\"%Y\") }}.pdf\n{% else %}\n    /home/Tax/{{ document.id }}.pdf\n{% endif %}\n\"\"\"\ncustom_fields = [\n    CField(name=\"Total\", value=245.02),\n    CField(name=\"Effective Date\", value=Date(2024, 12, 23)),\n]\ndoc = DocumentContext(\n    id=uuid.uuid4(),\n    title=\"coco\",\n    custom_fields=custom_fields,\n)\n\nev_path = get_evaluated_path(doc, path_template=path_tmpl)\nassert ev_path == PurePath(\"/home/Tax/2024.pdf\")\n```\n\n## Tests\n\n\n```shell\npoetry run pytest\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Path Template",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "88dca3e166dff25735072f17133ebdb557b34bc67db801c1cb7f8ea927d0f2cf",
                "md5": "ad9c7b9b8852868b30075d12f22968e4",
                "sha256": "9b32408e4d8e6dcb2974278b1bdc3aecc8470ee27b63dd223cb4e35fa051e1e1"
            },
            "downloads": -1,
            "filename": "pathtmpl-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad9c7b9b8852868b30075d12f22968e4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.13",
            "size": 3372,
            "upload_time": "2024-11-24T07:14:13",
            "upload_time_iso_8601": "2024-11-24T07:14:13.067172Z",
            "url": "https://files.pythonhosted.org/packages/88/dc/a3e166dff25735072f17133ebdb557b34bc67db801c1cb7f8ea927d0f2cf/pathtmpl-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5982ec92816b1fe19fa4cab5c314f0ec8fca5e227ca0f626bde86fe3b2fde63f",
                "md5": "7715dbebed1e2b1ad634eb050007055a",
                "sha256": "216e7eb5e3ffa6b8ffbeeb156c1feecd4215c09dc4e2eeeb29e4011b2710b3c7"
            },
            "downloads": -1,
            "filename": "pathtmpl-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7715dbebed1e2b1ad634eb050007055a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.13",
            "size": 2421,
            "upload_time": "2024-11-24T07:14:14",
            "upload_time_iso_8601": "2024-11-24T07:14:14.603269Z",
            "url": "https://files.pythonhosted.org/packages/59/82/ec92816b1fe19fa4cab5c314f0ec8fca5e227ca0f626bde86fe3b2fde63f/pathtmpl-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-24 07:14:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pathtmpl"
}