| Name | garmin-ace JSON |
| Version |
0.0.1a10
JSON |
| download |
| home_page | |
| Summary | Garmin Aviation Checklist Editor (ACE) - Parse and write ACE files from Python |
| upload_time | 2023-06-11 13:16:34 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Garmin Aviation Checklist Editor (ACE) - Python Module
======================================================
Convert ACE files to/from various formats (HTML, orgmode). Parse and write ACE files from Python.
## Installation
```
$ pip install garmin_ace
```
## Usage
Display the available formats:
```
$ ace-convert
Convert source file to destination file
Usage: ace-convert <source> <dest>
Supported source formats are: .org, .ace
Supported destination formats are: .ace, .html
```
### Example: Converting an ACE file to HTML and PDF
```
$ ace-convert checklist.ace checklist.html
```
You can further convert the HTML document to a PDF file with https://wkhtmltopdf.org/downloads.html
```
$ wkhtmltopdf checklist.html checklist.pdf
```
### Example: Converting orgmode checklists to the ACE format
Org mode is a plaintext format, which can be easier to edit and manipulate than the Garmin Checklist Editor app. It expects a simple structure:
```
* Pre-flight checklist
** Master: on
** Lights: on
** Master: off
* Startup checklist
** Master: on
...
```
The top level bullet points are the checklist names, and subitems are the checklist items.
To convert it to the other available formats:
```
$ ace-convert checklist.org checklist.ace
```
or
```
$ ace-convert checklist.org checklist.html
```
See https://orgmode.org/worg/org-syntax.html for details on the format.
### Decoding a ACE file to Python objects
```
from garmin_ace import ACEFileDecoder
checklists_obj = ACEFileDecoder.read_from_file('checklist.ace')
```
See `models.py` for the data structure.
### Encoding a ACE file from Python objects
```
from garmin_ace import ACEFileEncoder
ACEFileEncoder(checklists_obj).write_to_file('checklist2.ace')
```
## Running tests (source)
```
$ make test
$ make coverage
```
## Credits
Originally based on the Swift implementation https://github.com/RISCfuture/GarminACE
## License
Copyright (C) 2023 Xavier Antoviaque
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "garmin-ace",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Xavier Antoviaque <xavier@antoviaque.org>",
"download_url": "https://files.pythonhosted.org/packages/4c/ee/6b427225f9624d7a0af2d0aae801ca4b9e2c8ff9eeed905152184ced95c7/garmin_ace-0.0.1a10.tar.gz",
"platform": null,
"description": "Garmin Aviation Checklist Editor (ACE) - Python Module\n======================================================\n\nConvert ACE files to/from various formats (HTML, orgmode). Parse and write ACE files from Python.\n\n## Installation\n\n```\n$ pip install garmin_ace\n```\n\n## Usage\n\nDisplay the available formats:\n\n```\n$ ace-convert\nConvert source file to destination file\nUsage: ace-convert <source> <dest>\nSupported source formats are: .org, .ace\nSupported destination formats are: .ace, .html\n```\n\n### Example: Converting an ACE file to HTML and PDF\n\n```\n$ ace-convert checklist.ace checklist.html\n```\n\nYou can further convert the HTML document to a PDF file with https://wkhtmltopdf.org/downloads.html\n\n```\n$ wkhtmltopdf checklist.html checklist.pdf\n```\n\n### Example: Converting orgmode checklists to the ACE format\n\nOrg mode is a plaintext format, which can be easier to edit and manipulate than the Garmin Checklist Editor app. It expects a simple structure:\n\n```\n* Pre-flight checklist\n** Master: on\n** Lights: on\n** Master: off\n* Startup checklist\n** Master: on\n...\n```\n\nThe top level bullet points are the checklist names, and subitems are the checklist items.\n\nTo convert it to the other available formats:\n\n```\n$ ace-convert checklist.org checklist.ace\n```\n\nor \n\n```\n$ ace-convert checklist.org checklist.html\n```\n\nSee https://orgmode.org/worg/org-syntax.html for details on the format. \n\n### Decoding a ACE file to Python objects\n\n```\nfrom garmin_ace import ACEFileDecoder\n\nchecklists_obj = ACEFileDecoder.read_from_file('checklist.ace')\n```\n\nSee `models.py` for the data structure.\n\n### Encoding a ACE file from Python objects\n\n```\nfrom garmin_ace import ACEFileEncoder\n\nACEFileEncoder(checklists_obj).write_to_file('checklist2.ace')\n```\n\n## Running tests (source)\n\n```\n$ make test\n$ make coverage\n```\n\n## Credits\n\nOriginally based on the Swift implementation https://github.com/RISCfuture/GarminACE\n\n## License\n\nCopyright (C) 2023 Xavier Antoviaque\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published\nby the Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Garmin Aviation Checklist Editor (ACE) - Parse and write ACE files from Python",
"version": "0.0.1a10",
"project_urls": {
"Bug Tracker": "https://gitlab.com/antoviaque/garmin-ace/-/issues",
"Homepage": "https://gitlab.com/antoviaque/garmin-ace"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7303f195a7bd2a797a5122ec4666c39af64c7adfe0262134151d34825738cfc3",
"md5": "1e73dee487b87d0643b1e0ee36712afa",
"sha256": "0a7603f34fda5752a72834d571a9faeab898a9b5001e54d35bf0ff43dc9768c9"
},
"downloads": -1,
"filename": "garmin_ace-0.0.1a10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e73dee487b87d0643b1e0ee36712afa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20926,
"upload_time": "2023-06-11T13:16:32",
"upload_time_iso_8601": "2023-06-11T13:16:32.996109Z",
"url": "https://files.pythonhosted.org/packages/73/03/f195a7bd2a797a5122ec4666c39af64c7adfe0262134151d34825738cfc3/garmin_ace-0.0.1a10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4cee6b427225f9624d7a0af2d0aae801ca4b9e2c8ff9eeed905152184ced95c7",
"md5": "518edb38cbf5d62dee2a9a48f566c305",
"sha256": "07432bfda9874c7736196ba85aa3db856fe9bf0a4dbadf6b263ec9167ee9ca6b"
},
"downloads": -1,
"filename": "garmin_ace-0.0.1a10.tar.gz",
"has_sig": false,
"md5_digest": "518edb38cbf5d62dee2a9a48f566c305",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17917,
"upload_time": "2023-06-11T13:16:34",
"upload_time_iso_8601": "2023-06-11T13:16:34.646996Z",
"url": "https://files.pythonhosted.org/packages/4c/ee/6b427225f9624d7a0af2d0aae801ca4b9e2c8ff9eeed905152184ced95c7/garmin_ace-0.0.1a10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-11 13:16:34",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "antoviaque",
"gitlab_project": "garmin-ace",
"lcname": "garmin-ace"
}
