[](https://github.com/matthiasgi/directorium/actions?query=workflow:"Testing+code")
[](https://github.com/MatthiasGi/directorium/actions/workflows/docs.yml)
[](https://github.com/matthiasgi/directorium/actions?query=workflow:"Upload+Python+Package")
[](https://github.com/matthiasgi/directorium/releases/)
[](#license)
[](https://github.com/matthiasgi/directorium/issues)
# directorium
A wrapper package for the public API of https://eucharistiefeier.de/lk/. It is able to provide information from the liturgical calendar such as liturgical color and lectures. To start with the package just run:
```shell
pip install directorium
```
## Getting started
A sample usage would be:
```python
from datetime import date
from directorium import Directorium
directorium = Directorium.from_request()
today = date.today()
events = directorium.get_date(today)
print(events)
```
## Documentation
An automatically created documentation is available on [the GitHub Pages of this project](https://matthiasgi.github.io/directorium/).
## Contributing
You're more than invited to contribute to this project. Any kind of help is appreciated. Just open an issue or a pull request.
1. Fork the project
2. Add a python environment with `python -m venv .venv`
3. Activate the environment with `source .venv/bin/activate`
4. Install the development dependencies with `pip install -e .[development]`
5. Install the pre-commit hooks with `pre-commit install`
6. Create a new branch
7. Make your changes (remember to add tests!) and commit them
8. Install the test dependencies with `pip install -e .[test]`
9. Run the tests with `pytest`
10. Push your changes and open a pull request
## Acknowledgments
Thanks a lot to the [Salesians of Don Bosco](https://www.donbosco.de/) for providing the API!
## License
Released under [MIT](/LICENSE) by [@matthiasgi](https://github.com/matthiasgi).
Raw data
{
"_id": null,
"home_page": null,
"name": "directorium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "catholic, church, eucharistiefeier, liturgy, mass",
"author": null,
"author_email": "Matthias Gianfelice <matthias@gianfelice.de>",
"download_url": "https://files.pythonhosted.org/packages/53/ed/12da00462201688233f230582e13a37a5ef81cdcc9183d6d9f437c92654e/directorium-0.1.2.tar.gz",
"platform": null,
"description": "[](https://github.com/matthiasgi/directorium/actions?query=workflow:\"Testing+code\")\n[](https://github.com/MatthiasGi/directorium/actions/workflows/docs.yml)\n[](https://github.com/matthiasgi/directorium/actions?query=workflow:\"Upload+Python+Package\")\n\n[](https://github.com/matthiasgi/directorium/releases/)\n[](#license)\n[](https://github.com/matthiasgi/directorium/issues)\n\n# directorium\n\nA wrapper package for the public API of https://eucharistiefeier.de/lk/. It is able to provide information from the liturgical calendar such as liturgical color and lectures. To start with the package just run:\n```shell\npip install directorium\n```\n\n## Getting started\n\nA sample usage would be:\n```python\nfrom datetime import date\nfrom directorium import Directorium\n\ndirectorium = Directorium.from_request()\ntoday = date.today()\nevents = directorium.get_date(today)\nprint(events)\n```\n\n## Documentation\n\nAn automatically created documentation is available on [the GitHub Pages of this project](https://matthiasgi.github.io/directorium/).\n\n## Contributing\nYou're more than invited to contribute to this project. Any kind of help is appreciated. Just open an issue or a pull request.\n\n1. Fork the project\n2. Add a python environment with `python -m venv .venv`\n3. Activate the environment with `source .venv/bin/activate`\n4. Install the development dependencies with `pip install -e .[development]`\n5. Install the pre-commit hooks with `pre-commit install`\n6. Create a new branch\n7. Make your changes (remember to add tests!) and commit them\n8. Install the test dependencies with `pip install -e .[test]`\n9. Run the tests with `pytest`\n10. Push your changes and open a pull request\n\n## Acknowledgments\nThanks a lot to the [Salesians of Don Bosco](https://www.donbosco.de/) for providing the API!\n\n## License\n\nReleased under [MIT](/LICENSE) by [@matthiasgi](https://github.com/matthiasgi).\n",
"bugtrack_url": null,
"license": null,
"summary": "Wrapper for the public API of https://eucharistiefeier.de/lk/",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://matthiasgi.github.io/directorium/directorium.html",
"Issues": "https://github.com/MatthiasGi/directorium/issues",
"Repository": "https://github.com/MatthiasGi/directorium"
},
"split_keywords": [
"catholic",
" church",
" eucharistiefeier",
" liturgy",
" mass"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dbb217c450c36b3211f875ce445d5124456cdfd3f5741bf1e69bc13d2cc05a7a",
"md5": "c2eb5334505bbcb14c730491e8159371",
"sha256": "29cc3d9b6d986e2963f572e881e158152e3894f1ebaba8043ba8cd73a406a909"
},
"downloads": -1,
"filename": "directorium-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2eb5334505bbcb14c730491e8159371",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9495,
"upload_time": "2024-06-29T13:43:32",
"upload_time_iso_8601": "2024-06-29T13:43:32.753738Z",
"url": "https://files.pythonhosted.org/packages/db/b2/17c450c36b3211f875ce445d5124456cdfd3f5741bf1e69bc13d2cc05a7a/directorium-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "53ed12da00462201688233f230582e13a37a5ef81cdcc9183d6d9f437c92654e",
"md5": "0f57a5b53366c6b4fc54fdc54bbe8a10",
"sha256": "e97f3b451aecbb21b9ee1256524f486309b0a0078894ba836c0dc91037baa176"
},
"downloads": -1,
"filename": "directorium-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0f57a5b53366c6b4fc54fdc54bbe8a10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 66942,
"upload_time": "2024-06-29T13:43:34",
"upload_time_iso_8601": "2024-06-29T13:43:34.506813Z",
"url": "https://files.pythonhosted.org/packages/53/ed/12da00462201688233f230582e13a37a5ef81cdcc9183d6d9f437c92654e/directorium-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-29 13:43:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MatthiasGi",
"github_project": "directorium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "directorium"
}
JSON
