# AVEAS OpenLABEL
## Installation and usage
This library can be installed via pip using `pip install aveas_openlabel` or with poetry using `poetry add aveas_openlabel`.
The documentation with minimal examples can be found here: [understand-ai.github.io/aveas_openlabel/](https://understand-ai.github.io/aveas_openlabel/)
## Development
### Poetry
This package uses Poetry, a tool for dependency management and packaging.
Please install it via the official installer from [here](https://python-poetry.org/docs/).
In the root of the repository, you install all dependencies into a virtual environment using `poetry install`.
### Working with this repository
This repository employs several tools to ensure a constant and good code quality.
#### Black
[Black](https://black.readthedocs.io/en/stable/index.html) is a code formatter that we use to assure consistent code style across our projects.
Use it in-between, or after your code changes, via `poetry run black .` in the root directory of this repository.
Merge requests will only be merge-able if black has nothing to complain about.
#### MyPy
[Mypy](https://mypy.readthedocs.io/en/stable/) is a static type checker for Python.
Is assures type safety throughout our code and is necessary to ensure that our AVEAS OpenLABEL format is consistent
with the base ASAM OpenLABEL format.
Mypy can be run with `poetry run mypy .` in the root directory of this repository.
Merge requests will only be merge-able if MyPy has nothing to complain about.
### Ruff
[Ruff](https://docs.astral.sh/ruff/) is a Python linter and code formatter.
It can be run with `poetry run ruff .` in the root directory of this repository.
#### Documentation
Please write docstrings for the class itself and each of its class variables.
For inspiration of what to write into the docstring, look at the description of the object or field
in the official ASAM OpenLABEL spec ([link](https://www.asam.net/project-detail/asam-openlabel-v100/)).
The docstrings allow the use of reStructuredText ([link](https://pydoctor.readthedocs.io/en/latest/docformat/restructuredtext.html)).
We are using [pydoctor](https://pydoctor.readthedocs.io/en/latest/index.html) to automatically generate documentation from the docstrings in our code.
The documentation generation can be run using `poetry run pydoctor` and is written in the directory `documentation/`
in the root of this repository.
If administrator privileges required for this operation under MS Windows and poetry is not installed for the administrator account, poetry can be run from Powershell via:
```Start-Process poetry -ArgumentList "run pydoctor" -Verb runAs```
The documentation is ignored from Git, as it is better to generate it by hand from the latest commit.
Raw data
{
"_id": null,
"home_page": "https://github.com/understand-ai/aveas_openlabel",
"name": "aveas-openlabel",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "ASAM OpenLABEL, AVEAS",
"author": "understand.ai",
"author_email": "postmaster@understand.ai",
"download_url": "https://files.pythonhosted.org/packages/a9/ad/44d806601bed00b4858e8e8e47b545975066aa460ee1ca978ba2607f4637/aveas_openlabel-0.4.12.tar.gz",
"platform": null,
"description": "# AVEAS OpenLABEL\n\n## Installation and usage\n\nThis library can be installed via pip using `pip install aveas_openlabel` or with poetry using `poetry add aveas_openlabel`.\nThe documentation with minimal examples can be found here: [understand-ai.github.io/aveas_openlabel/](https://understand-ai.github.io/aveas_openlabel/)\n\n\n## Development\n### Poetry\nThis package uses Poetry, a tool for dependency management and packaging. \nPlease install it via the official installer from [here](https://python-poetry.org/docs/).\nIn the root of the repository, you install all dependencies into a virtual environment using `poetry install`. \n\n### Working with this repository\nThis repository employs several tools to ensure a constant and good code quality. \n\n#### Black\n[Black](https://black.readthedocs.io/en/stable/index.html) is a code formatter that we use to assure consistent code style across our projects. \nUse it in-between, or after your code changes, via `poetry run black .` in the root directory of this repository. \nMerge requests will only be merge-able if black has nothing to complain about. \n\n#### MyPy\n[Mypy](https://mypy.readthedocs.io/en/stable/) is a static type checker for Python. \nIs assures type safety throughout our code and is necessary to ensure that our AVEAS OpenLABEL format is consistent \nwith the base ASAM OpenLABEL format. \nMypy can be run with `poetry run mypy .` in the root directory of this repository.\nMerge requests will only be merge-able if MyPy has nothing to complain about. \n\n### Ruff\n[Ruff](https://docs.astral.sh/ruff/) is a Python linter and code formatter.\nIt can be run with `poetry run ruff .` in the root directory of this repository.\n\n#### Documentation\nPlease write docstrings for the class itself and each of its class variables. \nFor inspiration of what to write into the docstring, look at the description of the object or field \nin the official ASAM OpenLABEL spec ([link](https://www.asam.net/project-detail/asam-openlabel-v100/)). \nThe docstrings allow the use of reStructuredText ([link](https://pydoctor.readthedocs.io/en/latest/docformat/restructuredtext.html)).\n\nWe are using [pydoctor](https://pydoctor.readthedocs.io/en/latest/index.html) to automatically generate documentation from the docstrings in our code. \nThe documentation generation can be run using `poetry run pydoctor` and is written in the directory `documentation/` \nin the root of this repository.\n\nIf administrator privileges required for this operation under MS Windows and poetry is not installed for the administrator account, poetry can be run from Powershell via:\n\n```Start-Process poetry -ArgumentList \"run pydoctor\" -Verb runAs```\n\nThe documentation is ignored from Git, as it is better to generate it by hand from the latest commit. \n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The AVEAS OpenLABEL specification",
"version": "0.4.12",
"project_urls": {
"Homepage": "https://github.com/understand-ai/aveas_openlabel",
"Repository": "https://github.com/understand-ai/aveas_openlabel"
},
"split_keywords": [
"asam openlabel",
" aveas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9aeacaa522a062d66c16946579e36bb796fed7acc29532ecebba4fc360426ccd",
"md5": "55364a4befacf151429146d39ecc820c",
"sha256": "88904c6a0b8f68fee93d2effc41fe4d4da7d49390f135ffbaeb07205fe437bdc"
},
"downloads": -1,
"filename": "aveas_openlabel-0.4.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55364a4befacf151429146d39ecc820c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 91471,
"upload_time": "2024-04-30T07:12:36",
"upload_time_iso_8601": "2024-04-30T07:12:36.428065Z",
"url": "https://files.pythonhosted.org/packages/9a/ea/caa522a062d66c16946579e36bb796fed7acc29532ecebba4fc360426ccd/aveas_openlabel-0.4.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9ad44d806601bed00b4858e8e8e47b545975066aa460ee1ca978ba2607f4637",
"md5": "65deb8e1127a7d7ef07a2cccc22a4789",
"sha256": "7a02d806d943737f621a518108aad1e5e9dbfa78522effc3803b975d4f69ef4b"
},
"downloads": -1,
"filename": "aveas_openlabel-0.4.12.tar.gz",
"has_sig": false,
"md5_digest": "65deb8e1127a7d7ef07a2cccc22a4789",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 31384,
"upload_time": "2024-04-30T07:12:38",
"upload_time_iso_8601": "2024-04-30T07:12:38.171456Z",
"url": "https://files.pythonhosted.org/packages/a9/ad/44d806601bed00b4858e8e8e47b545975066aa460ee1ca978ba2607f4637/aveas_openlabel-0.4.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 07:12:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "understand-ai",
"github_project": "aveas_openlabel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aveas-openlabel"
}
JSON
