<!--
SPDX-FileCopyrightText: Magenta ApS <https://magenta.dk>
SPDX-License-Identifier: MPL-2.0
-->
# MoLoRa Data Models
RAModels - MoLoRa data validation models powered by [pydantic](https://github.com/samuelcolvin/pydantic/#pydantic).
## Versioning
This project uses [Semantic Versioning](https://semver.org/) with the following strategy:
- MAJOR: Incompatible changes to existing data models
- MINOR: Backwards compatible updates to existing data models OR new models added
- PATCH: Backwards compatible bug fixes
## Authors
Magenta ApS <https://magenta.dk>
## License
- This project: [MPL-2.0](MPL-2.0.txt)
- Dependencies:
- pydantic: [MIT](MIT.txt)
This project uses [REUSE](https://reuse.software) for licensing. All licenses can be found in the [LICENSES folder](LICENSES/) of the project.
## Development
### Prerequisites
- [Poetry](https://github.com/python-poetry/poetry)
- [Pre-commit](https://github.com/pre-commit/pre-commit)
### Getting Started
1. Clone the repository:
`git clone git@git.magenta.dk:rammearkitektur/ra-data-models.git`
2. Install all dependencies:
`poetry install`
3. Set up pre-commit:
`pre-commit install`
### Running the tests
You use `poetry` and `pytest` to run the tests:
`poetry run pytest`
You can also run specific files
`poetry run pytest tests/<test_folder>/<test_file.py>`
and even use filtering with `-k`
`poetry run pytest -k "Manager"`
You can use the flags `-vx` where `v` prints the test & `x` makes the test stop if any tests fails (Verbose, X-fail)
### Pre-commit usage
Pre-commit must either be used via your virtual environment or globally.
If you want to pre-commit globally, the following extra dependencies are needed:
`pip install mypy pydantic`
### Models
## LoRa
`LoRa` implements the OIO standard version 1.1. The [standard](https://digitaliser.dk/resource/1569113) with
[specification](https://www.digitaliser.dk/resource/1569113/artefact/Specifikationafserviceinterfacefororganisation-OIO-Godkendt%5bvs.1.1%5d.pdf?artefact=true&PID=1569586)
Raw data
{
"_id": null,
"home_page": "https://magenta.dk/",
"name": "ramodels",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "os2mo, data models",
"author": "Magenta",
"author_email": "info@magenta.dk",
"download_url": "https://files.pythonhosted.org/packages/79/39/8324711837f7e9833f03fc4139fceaedb8eb610c1347e47d7e88a4e5838a/ramodels-34.7.0.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: Magenta ApS <https://magenta.dk>\nSPDX-License-Identifier: MPL-2.0\n-->\n\n\n# MoLoRa Data Models\n\nRAModels - MoLoRa data validation models powered by [pydantic](https://github.com/samuelcolvin/pydantic/#pydantic).\n\n## Versioning\nThis project uses [Semantic Versioning](https://semver.org/) with the following strategy:\n- MAJOR: Incompatible changes to existing data models\n- MINOR: Backwards compatible updates to existing data models OR new models added\n- PATCH: Backwards compatible bug fixes\n\n\n## Authors\n\nMagenta ApS <https://magenta.dk>\n\n## License\n- This project: [MPL-2.0](MPL-2.0.txt)\n- Dependencies:\n - pydantic: [MIT](MIT.txt)\n\nThis project uses [REUSE](https://reuse.software) for licensing. All licenses can be found in the [LICENSES folder](LICENSES/) of the project.\n\n## Development\n### Prerequisites\n\n- [Poetry](https://github.com/python-poetry/poetry)\n- [Pre-commit](https://github.com/pre-commit/pre-commit)\n\n\n### Getting Started\n\n1. Clone the repository:\n`git clone git@git.magenta.dk:rammearkitektur/ra-data-models.git`\n\n2. Install all dependencies:\n`poetry install`\n\n3. Set up pre-commit:\n`pre-commit install`\n\n\n### Running the tests\n\nYou use `poetry` and `pytest` to run the tests:\n\n`poetry run pytest`\n\n\nYou can also run specific files\n\n`poetry run pytest tests/<test_folder>/<test_file.py>`\n\nand even use filtering with `-k`\n\n`poetry run pytest -k \"Manager\"`\n\n\nYou can use the flags `-vx` where `v` prints the test & `x` makes the test stop if any tests fails (Verbose, X-fail)\n\n### Pre-commit usage\nPre-commit must either be used via your virtual environment or globally.\nIf you want to pre-commit globally, the following extra dependencies are needed:\n`pip install mypy pydantic`\n\n\n### Models\n\n## LoRa\n`LoRa` implements the OIO standard version 1.1. The [standard](https://digitaliser.dk/resource/1569113) with\n[specification](https://www.digitaliser.dk/resource/1569113/artefact/Specifikationafserviceinterfacefororganisation-OIO-Godkendt%5bvs.1.1%5d.pdf?artefact=true&PID=1569586)\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Pydantic data models for OS2mo",
"version": "34.7.0",
"project_urls": {
"Homepage": "https://magenta.dk/",
"Repository": "https://git.magenta.dk/rammearkitektur/os2mo"
},
"split_keywords": [
"os2mo",
" data models"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f1f65a11effd8fd2d7333ac45a978dbd0cb130aebab72b4feedbed7f0f5a877",
"md5": "a9be38cee5b6844a8480b1e100afdf9c",
"sha256": "059fd7e8099956dbdd7b20d83436cd8f13432f5374ce7361c2118227a78466e3"
},
"downloads": -1,
"filename": "ramodels-34.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9be38cee5b6844a8480b1e100afdf9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 33572,
"upload_time": "2024-04-11T12:46:31",
"upload_time_iso_8601": "2024-04-11T12:46:31.418927Z",
"url": "https://files.pythonhosted.org/packages/9f/1f/65a11effd8fd2d7333ac45a978dbd0cb130aebab72b4feedbed7f0f5a877/ramodels-34.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "79398324711837f7e9833f03fc4139fceaedb8eb610c1347e47d7e88a4e5838a",
"md5": "4fbcc4c40ddd06142ca2cbfe84a7e9df",
"sha256": "37d4014033577f54128fd1ba747b2e7ca8dc7a32b0f4b73cdc4b4a6e61fee998"
},
"downloads": -1,
"filename": "ramodels-34.7.0.tar.gz",
"has_sig": false,
"md5_digest": "4fbcc4c40ddd06142ca2cbfe84a7e9df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 20981,
"upload_time": "2024-04-11T12:46:36",
"upload_time_iso_8601": "2024-04-11T12:46:36.036294Z",
"url": "https://files.pythonhosted.org/packages/79/39/8324711837f7e9833f03fc4139fceaedb8eb610c1347e47d7e88a4e5838a/ramodels-34.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-11 12:46:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ramodels"
}
JSON