| Name | yaml2ics JSON |
| Version |
0.2
JSON |
| download |
| home_page | None |
| Summary | yaml2ics |
| upload_time | 2023-04-14 05:57:30 |
| maintainer | None |
| docs_url | None |
| author | Scientific Python Developers |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/yaml2ics/)
[](https://github.com/scientific-python/yaml2ics/actions?query=workflow%3A%22test%22)
[](https://app.codecov.io/gh/scientific-python/yaml2ics/branch/main)
# YAML to iCalendar (ics)
| WARNING: this project is still in beta. Beware of breaking changes! |
| ------------------------------------------------------------------- |
Convert YAML files to .ics files which can be imported into other
calendar applications.
Features include:
- Converting single .yaml files, or combining multiple into one .ics
file.
- ics fields: name, summary, description, location, timezone, repeat
- Specify event start+end or start+duration
- Recurring events (basic support)
- All-day events
- Timezone specification (default or per-event)
## Installation
```
pip install yaml2ics
```
## Usage
To produce a calendar from a list of events:
```
python yaml2ics.py example/test_calendar.yaml
```
To combine lists of events in to a calendar:
```
python yaml2ics.py example/test_calendar.yaml example/another_calendar.yaml
```
## Syntax
Please see `example/test_calendar.yaml` for a full demo including
explanations. Below is a minimal template that shows the basic idea:
```yaml
name: Calendar Name
timezone: Europe/Helsinki # default timezone for events, optional
events:
- summary: The event title
begin: 2021-09-21 15:00:00
duration:
minutes: 30
location: |
https://meet.jit.si/example
description: |
In this meeting we will ...
```
## Contributing
Contributions are welcomed! This project is still in active development
and should be considered beta.
To install the development version, fork the source of the project and make an
editable install:
```
pip install -e ".[test]"
```
To test:
```
pytest
```
Generate a coverage report with:
```
pytest --cov-report term-missing --cov yaml2ics
```
[black](https://github.com/psf/black) and other linters are used to auto-format
files (and enforced by CI). To install the git hooks, use `pre-commit install`.
To run the tests/auto-formatting manually, use `pre-commit run --all-files`.
Raw data
{
"_id": null,
"home_page": null,
"name": "yaml2ics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Scientific Python Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3e/fe/ea7f92a7a0d9f6b9e76fb494de8813f94528db82379d0e7610bd2c3f5c5c/yaml2ics-0.2.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/yaml2ics/)\n[](https://github.com/scientific-python/yaml2ics/actions?query=workflow%3A%22test%22)\n[](https://app.codecov.io/gh/scientific-python/yaml2ics/branch/main)\n\n# YAML to iCalendar (ics)\n\n| WARNING: this project is still in beta. Beware of breaking changes! |\n| ------------------------------------------------------------------- |\n\nConvert YAML files to .ics files which can be imported into other\ncalendar applications.\n\nFeatures include:\n\n- Converting single .yaml files, or combining multiple into one .ics\n file.\n- ics fields: name, summary, description, location, timezone, repeat\n- Specify event start+end or start+duration\n- Recurring events (basic support)\n- All-day events\n- Timezone specification (default or per-event)\n\n## Installation\n\n```\npip install yaml2ics\n```\n\n## Usage\n\nTo produce a calendar from a list of events:\n\n```\npython yaml2ics.py example/test_calendar.yaml\n```\n\nTo combine lists of events in to a calendar:\n\n```\npython yaml2ics.py example/test_calendar.yaml example/another_calendar.yaml\n```\n\n## Syntax\n\nPlease see `example/test_calendar.yaml` for a full demo including\nexplanations. Below is a minimal template that shows the basic idea:\n\n```yaml\nname: Calendar Name\ntimezone: Europe/Helsinki # default timezone for events, optional\n\nevents:\n - summary: The event title\n begin: 2021-09-21 15:00:00\n duration:\n minutes: 30\n location: |\n https://meet.jit.si/example\n description: |\n In this meeting we will ...\n```\n\n## Contributing\n\nContributions are welcomed! This project is still in active development\nand should be considered beta.\n\nTo install the development version, fork the source of the project and make an\neditable install:\n\n```\npip install -e \".[test]\"\n```\n\nTo test:\n\n```\npytest\n```\n\nGenerate a coverage report with:\n\n```\npytest --cov-report term-missing --cov yaml2ics\n```\n\n[black](https://github.com/psf/black) and other linters are used to auto-format\nfiles (and enforced by CI). To install the git hooks, use `pre-commit install`.\nTo run the tests/auto-formatting manually, use `pre-commit run --all-files`.\n",
"bugtrack_url": null,
"license": null,
"summary": "yaml2ics",
"version": "0.2",
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b93b9f08a240f3def0079dd1e4d96db1dc65d115be023a9523a27a2e66e9099b",
"md5": "96d4be38af7b2ae0605ad13cbb8a6695",
"sha256": "980b13fa7fa1d5007cc077d8b81aca18b6f6110a31154a44a406b7063484c018"
},
"downloads": -1,
"filename": "yaml2ics-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96d4be38af7b2ae0605ad13cbb8a6695",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5695,
"upload_time": "2023-04-14T05:57:25",
"upload_time_iso_8601": "2023-04-14T05:57:25.257008Z",
"url": "https://files.pythonhosted.org/packages/b9/3b/9f08a240f3def0079dd1e4d96db1dc65d115be023a9523a27a2e66e9099b/yaml2ics-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3efeea7f92a7a0d9f6b9e76fb494de8813f94528db82379d0e7610bd2c3f5c5c",
"md5": "765ab91818b701149e94c46693e81e1a",
"sha256": "6811af98878b479de58846ce68be7da4b20eeafea438181e8592a859bb78ed94"
},
"downloads": -1,
"filename": "yaml2ics-0.2.tar.gz",
"has_sig": false,
"md5_digest": "765ab91818b701149e94c46693e81e1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8986,
"upload_time": "2023-04-14T05:57:30",
"upload_time_iso_8601": "2023-04-14T05:57:30.018846Z",
"url": "https://files.pythonhosted.org/packages/3e/fe/ea7f92a7a0d9f6b9e76fb494de8813f94528db82379d0e7610bd2c3f5c5c/yaml2ics-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-14 05:57:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "yaml2ics"
}
