| Name | turtle-canon JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A tool for canonizing Turtle (`.ttl`) ontology files. |
| upload_time | 2025-02-19 20:10:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.10 |
| license | MIT License
Copyright (c) 2021-2025 Casper Welzel Andersen & SINTEF
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
ontology
turtle
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Turtle Canon
<!-- markdownlint-disable-next-line MD036 -->
*It's turtles all the way down*
[](https://app.codecov.io/gh/CasperWA/turtle-canon)
[](https://github.com/CasperWA/turtle-canon/actions/workflows/ci_tests.yml?query=branch%3Amain)
A tool for canonizing Turtle (`.ttl`) ontology files.
The domain standardized tool for editing and creating ontologies is [Protégé](https://protege.stanford.edu/).
The Turtle (`.ttl`) file format is a format based on XML and OWL, which is considered one of the most readable formats for OWL ontology files.
However, Protégé writes the order of ontology entities differently depending on the version, this tool mitigates this by running the file through a canonizing parser that ensures the classes are sorted and listed in the same way, always.
The main use case for developing this tool is when developing ontologies utilizing versioning tools such as `git`, `svn` or similar, which are single character diff-sensitive.
## Install
The tool is written for Python 3.10, so one needs at minimum Python 3.10 installed to run it at this stage.
The plan is to make a stand-alone executable for each of the major OS'.
Install via PyPI (stable version, recommended):
```shell
python3.10 -m pip install turtle-canon
```
Install via GitHub (development version):
```shell
python3.10 -m pip install git+https://github.com/CasperWA/turtle-canon#egg=turtle-canon
```
## Usage
To run the tool, simply run:
```shell
turtle-canon path/to/my_ontology_file.ttl
```
For more information about the tool and the options available, run `turtle-canon --help`.
To check the version run `turtle-canon --version`.
The currently latest stable version is **0.1.1**.
## License & copyright
This tool is [MIT Licensed](LICENSE) and copyright © 2021 Casper Welzel Andersen ([GitHub](https://github.com/CasperWA), [GitLab](https://gitlab.com/CasperWA), [website](https://casper.welzel.nu)) & SINTEF.
Raw data
{
"_id": null,
"home_page": null,
"name": "turtle-canon",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.10",
"maintainer_email": "Casper Welzel Andersen <casper.w.andersen@sintef.no>, \"Tor S. Haugland\" <tor.haugland@sintef.no>",
"keywords": "ontology, turtle",
"author": null,
"author_email": "Casper Welzel Andersen <casper.w.andersen@sintef.no>",
"download_url": "https://files.pythonhosted.org/packages/50/17/dbe7ef2e30851889d3fc61e9a60bce74d2a1c2a57b459b87e49ef998ef06/turtle_canon-0.1.1.tar.gz",
"platform": null,
"description": "# Turtle Canon\n\n<!-- markdownlint-disable-next-line MD036 -->\n*It's turtles all the way down*\n\n[](https://app.codecov.io/gh/CasperWA/turtle-canon)\n[](https://github.com/CasperWA/turtle-canon/actions/workflows/ci_tests.yml?query=branch%3Amain)\n\nA tool for canonizing Turtle (`.ttl`) ontology files.\n\nThe domain standardized tool for editing and creating ontologies is [Prot\u00e9g\u00e9](https://protege.stanford.edu/).\nThe Turtle (`.ttl`) file format is a format based on XML and OWL, which is considered one of the most readable formats for OWL ontology files.\nHowever, Prot\u00e9g\u00e9 writes the order of ontology entities differently depending on the version, this tool mitigates this by running the file through a canonizing parser that ensures the classes are sorted and listed in the same way, always.\n\nThe main use case for developing this tool is when developing ontologies utilizing versioning tools such as `git`, `svn` or similar, which are single character diff-sensitive.\n\n## Install\n\nThe tool is written for Python 3.10, so one needs at minimum Python 3.10 installed to run it at this stage.\nThe plan is to make a stand-alone executable for each of the major OS'.\n\nInstall via PyPI (stable version, recommended):\n\n```shell\npython3.10 -m pip install turtle-canon\n```\n\nInstall via GitHub (development version):\n\n```shell\npython3.10 -m pip install git+https://github.com/CasperWA/turtle-canon#egg=turtle-canon\n```\n\n## Usage\n\nTo run the tool, simply run:\n\n```shell\nturtle-canon path/to/my_ontology_file.ttl\n```\n\nFor more information about the tool and the options available, run `turtle-canon --help`. \nTo check the version run `turtle-canon --version`.\n\nThe currently latest stable version is **0.1.1**.\n\n## License & copyright\n\nThis tool is [MIT Licensed](LICENSE) and copyright © 2021 Casper Welzel Andersen ([GitHub](https://github.com/CasperWA), [GitLab](https://gitlab.com/CasperWA), [website](https://casper.welzel.nu)) & SINTEF.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2021-2025 Casper Welzel Andersen & SINTEF\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A tool for canonizing Turtle (`.ttl`) ontology files.",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/CasperWA/turtle-canon/blob/main/CHANGELOG.md",
"Documentation": "https://CasperWA.github.io/turtle-canon",
"Home": "https://CasperWA.github.io/turtle-canon",
"Issue Tracker": "https://github.com/CasperWA/turtle-canon/issues",
"Package": "https://pypi.org/project/turtle-canon",
"Source": "https://github.com/CasperWA/turtle-canon"
},
"split_keywords": [
"ontology",
" turtle"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9fd0c5fc35748ffb5fae51ea1b16ab46ca48c217543c3d33a5aba1913df618ac",
"md5": "343449979e96a6267fe15f048a1d8b55",
"sha256": "2ac59c984c7b4451a4df2f06ff3cefc83bd050837e1f17075380d06a116a5c8b"
},
"downloads": -1,
"filename": "turtle_canon-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "343449979e96a6267fe15f048a1d8b55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.10",
"size": 10375,
"upload_time": "2025-02-19T20:10:24",
"upload_time_iso_8601": "2025-02-19T20:10:24.705702Z",
"url": "https://files.pythonhosted.org/packages/9f/d0/c5fc35748ffb5fae51ea1b16ab46ca48c217543c3d33a5aba1913df618ac/turtle_canon-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5017dbe7ef2e30851889d3fc61e9a60bce74d2a1c2a57b459b87e49ef998ef06",
"md5": "e6218ff8f5f634f38724fb018c9d21c9",
"sha256": "77d14a7172e2331f6c7a08fe362e0b09303dbf3a624d4cce94376568b1946d1d"
},
"downloads": -1,
"filename": "turtle_canon-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e6218ff8f5f634f38724fb018c9d21c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.10",
"size": 26639,
"upload_time": "2025-02-19T20:10:26",
"upload_time_iso_8601": "2025-02-19T20:10:26.127862Z",
"url": "https://files.pythonhosted.org/packages/50/17/dbe7ef2e30851889d3fc61e9a60bce74d2a1c2a57b459b87e49ef998ef06/turtle_canon-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 20:10:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CasperWA",
"github_project": "turtle-canon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "turtle-canon"
}
