| Name | cronspell JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Date-expression domain specific language parsing. A neat way to express things like "First Saturday of any year", or "3rd thursdays each month" and such |
| upload_time | 2024-12-21 12:08:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
configuration
cron
crontab
date
datetime
dsl
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Cronspell Python Package / CLI Tool
***Chronometry Spelled Out***
[![Github Pages][Github Pages]][Github Pages Link]
| | |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Details | [![Tests][Tests-image]][Tests-link] [![License - MIT][MIT-image]][MIT-link] |
| Features | [![linting - Ruff][ruff-image]][ruff-link] [![types - mypy][mypy-image]][mypy-link] [![test - pytest][pytest-image]][pytest-link] [![Pre-Commit][precommit-image]][precommit-link] [![docs - mkdocs][mkdocs-image]][mkdocs-link] |
Date-expression domain specific language parsing. A neat way to express things like "First Saturday of any year", or "3rd thursdays each month" and such.
## Installation
### Just the python module
If you need just the python function to parse cronspell expressions:
```shell
pip install cronspell
```
### With cli tools
If you like to use it in your command line:
```shell
pip install 'cronspell[cli]'
```
## Features
### Python
Cronspell is heavily inspired by Grafana's relative Date picker user interface. It shines when configuration is needed to reflect irregular date-distances such as in the example below.
`cronspell` lets you express relative dates such as "last saturday of last month" and converts it to a date object for use in your python project.
```python
from cronspell import parse
# Cronspell's purpose is mostly to parse configuration files written in yaml
# and therein express relative date times in a human friendly manner.
# here is but a simple demo:
last_saturday = parse("now/sat")
...
```
### Cli
The same interface, exposed to the command line. Formatted via `isodate` by default -- which is
open for configuration using the `--format` option.
This is how you get the last saturday of the current month, for example:
```bash
cronspell parse "now /month + 34 days /m -1d /sat"
```
## Example
To get the last saturday of last month:
```
"now /m -1d /sat"
```
The same, more verbose:
```
"now /month -1day /sat"
```
## Pre-Commit Hook: Validation
Cronspell comes with a pre-commit hook that validates configured date-expressions based on
yamlpath.
Check out the [documentation][Github Pages Link] for detailed instructions.
## Credits
* Domain-Specific-Language Parser: [TextX]
* This package was created with [The Hatchlor] project template.
[TextX]: https://textx.github.io/textX/
[The Hatchlor]: https://github.com/florianwilhelm/the-hatchlor
[Tests-image]: https://github.com/iilei/cronspell/actions/workflows/tests.yml/badge.svg?branch=master
[Tests-link]: https://github.com/iilei/cronspell/actions/workflows/tests.yml
[hatch-image]: https://img.shields.io/badge/%F0%9F%A5%9A-hatch-4051b5.svg
[hatch-link]: https://github.com/pypa/hatch
[ruff-image]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
[ruff-link]: https://github.com/charliermarsh/ruff
[mypy-image]: https://img.shields.io/badge/Types-mypy-blue.svg
[mypy-link]: https://mypy-lang.org/
[pytest-image]: https://img.shields.io/static/v1?label=&message=Pytest&logo=Pytest&color=0A9EDC&logoColor=white
[pytest-link]: https://docs.pytest.org/
[mkdocs-image]: https://img.shields.io/static/v1?label=&message=mkdocs&logo=Material+for+MkDocs&color=526CFE&logoColor=white
[mkdocs-link]: https://www.mkdocs.org/
[precommit-image]: https://img.shields.io/static/v1?label=&message=pre-commit&logo=pre-commit&color=76877c
[precommit-link]: https://pre-commit.com/
[MIT-image]: https://img.shields.io/badge/License-MIT-9400d3.svg
[MIT-link]: LICENSE.txt
[Github Pages]: https://img.shields.io/badge/github%20pages-121013?style=for-the-badge&logo=github&logoColor=teal
[Github Pages Link]: https://iilei.github.io/cronspell/
Raw data
{
"_id": null,
"home_page": null,
"name": "cronspell",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "configuration, cron, crontab, date, datetime, dsl",
"author": null,
"author_email": "Jochen Preusche <922226+iilei@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/51/21/e076f850f672cce619bebf3c7f7c7e6538659ba58fa12c1154995db77ac9/cronspell-0.1.0.tar.gz",
"platform": null,
"description": "\n# Cronspell Python Package / CLI Tool\n***Chronometry Spelled Out***\n\n\n[![Github Pages][Github Pages]][Github Pages Link]\n\n\n| | |\n| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Details | [![Tests][Tests-image]][Tests-link] [![License - MIT][MIT-image]][MIT-link] |\n| Features | [![linting - Ruff][ruff-image]][ruff-link] [![types - mypy][mypy-image]][mypy-link] [![test - pytest][pytest-image]][pytest-link] [![Pre-Commit][precommit-image]][precommit-link] [![docs - mkdocs][mkdocs-image]][mkdocs-link] |\n\nDate-expression domain specific language parsing. A neat way to express things like \"First Saturday of any year\", or \"3rd thursdays each month\" and such.\n\n## Installation\n\n### Just the python module\n\nIf you need just the python function to parse cronspell expressions:\n\n```shell\npip install cronspell\n```\n\n### With cli tools\n\nIf you like to use it in your command line:\n\n```shell\npip install 'cronspell[cli]'\n```\n\n\n## Features\n\n\n### Python\n\nCronspell is heavily inspired by Grafana's relative Date picker user interface. It shines when configuration is needed to reflect irregular date-distances such as in the example below.\n\n`cronspell` lets you express relative dates such as \"last saturday of last month\" and converts it to a date object for use in your python project.\n\n```python\nfrom cronspell import parse\n\n# Cronspell's purpose is mostly to parse configuration files written in yaml\n# and therein express relative date times in a human friendly manner.\n\n# here is but a simple demo:\nlast_saturday = parse(\"now/sat\")\n...\n```\n\n### Cli\n\nThe same interface, exposed to the command line. Formatted via `isodate` by default -- which is\nopen for configuration using the `--format` option.\n\nThis is how you get the last saturday of the current month, for example:\n\n```bash\ncronspell parse \"now /month + 34 days /m -1d /sat\"\n```\n\n## Example\n\nTo get the last saturday of last month:\n\n```\n\"now /m -1d /sat\"\n```\n\nThe same, more verbose:\n```\n\"now /month -1day /sat\"\n```\n\n\n## Pre-Commit Hook: Validation\n\nCronspell comes with a pre-commit hook that validates configured date-expressions based on\nyamlpath.\n\nCheck out the [documentation][Github Pages Link] for detailed instructions.\n\n## Credits\n\n* Domain-Specific-Language Parser: [TextX]\n* This package was created with [The Hatchlor] project template.\n\n[TextX]: https://textx.github.io/textX/\n[The Hatchlor]: https://github.com/florianwilhelm/the-hatchlor\n\n\n[Tests-image]: https://github.com/iilei/cronspell/actions/workflows/tests.yml/badge.svg?branch=master\n[Tests-link]: https://github.com/iilei/cronspell/actions/workflows/tests.yml\n[hatch-image]: https://img.shields.io/badge/%F0%9F%A5%9A-hatch-4051b5.svg\n[hatch-link]: https://github.com/pypa/hatch\n[ruff-image]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n[ruff-link]: https://github.com/charliermarsh/ruff\n[mypy-image]: https://img.shields.io/badge/Types-mypy-blue.svg\n[mypy-link]: https://mypy-lang.org/\n[pytest-image]: https://img.shields.io/static/v1?label=\u200e&message=Pytest&logo=Pytest&color=0A9EDC&logoColor=white\n[pytest-link]: https://docs.pytest.org/\n[mkdocs-image]: https://img.shields.io/static/v1?label=\u200e&message=mkdocs&logo=Material+for+MkDocs&color=526CFE&logoColor=white\n[mkdocs-link]: https://www.mkdocs.org/\n[precommit-image]: https://img.shields.io/static/v1?label=\u200e&message=pre-commit&logo=pre-commit&color=76877c\n[precommit-link]: https://pre-commit.com/\n[MIT-image]: https://img.shields.io/badge/License-MIT-9400d3.svg\n[MIT-link]: LICENSE.txt\n[Github Pages]: https://img.shields.io/badge/github%20pages-121013?style=for-the-badge&logo=github&logoColor=teal\n[Github Pages Link]: https://iilei.github.io/cronspell/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Date-expression domain specific language parsing. A neat way to express things like \"First Saturday of any year\", or \"3rd thursdays each month\" and such",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/iilei/cronspell",
"Source": "https://github.com/iilei/cronspell"
},
"split_keywords": [
"configuration",
" cron",
" crontab",
" date",
" datetime",
" dsl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ebf2e90aae9e049628dfa1ce51dbe62394d8429b24fb0ec2ff666e44f8de121",
"md5": "330ff993535466dcbf529ae7c2268be7",
"sha256": "09522a339fa017b3050f6482596613f474f97e8fa6381c86d732ae9d322d420a"
},
"downloads": -1,
"filename": "cronspell-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "330ff993535466dcbf529ae7c2268be7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13603,
"upload_time": "2024-12-21T12:08:19",
"upload_time_iso_8601": "2024-12-21T12:08:19.626680Z",
"url": "https://files.pythonhosted.org/packages/4e/bf/2e90aae9e049628dfa1ce51dbe62394d8429b24fb0ec2ff666e44f8de121/cronspell-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5121e076f850f672cce619bebf3c7f7c7e6538659ba58fa12c1154995db77ac9",
"md5": "a6fbbdfe8a9960c453d83d019a5c7634",
"sha256": "8079b8f73587d8390a1d37a6242af422e6069426f632ea87053930c5accb51b9"
},
"downloads": -1,
"filename": "cronspell-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a6fbbdfe8a9960c453d83d019a5c7634",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12548,
"upload_time": "2024-12-21T12:08:22",
"upload_time_iso_8601": "2024-12-21T12:08:22.133794Z",
"url": "https://files.pythonhosted.org/packages/51/21/e076f850f672cce619bebf3c7f7c7e6538659ba58fa12c1154995db77ac9/cronspell-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 12:08:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iilei",
"github_project": "cronspell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cronspell"
}
