| Name | capella2polarion JSON |
| Version |
1.4.1
JSON |
| download |
| home_page | None |
| Summary | Synchronise Capella models with Polarion projects |
| upload_time | 2024-12-10 17:02:45 |
| maintainer | None |
| docs_url | None |
| author | DB InfraGO AG |
| requires_python | <3.13,>=3.10 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
~ Copyright DB InfraGO AG and contributors
~ SPDX-License-Identifier: Apache-2.0
-->
# capella2polarion
<!-- prettier-ignore -->
Synchronise Capella models with Polarion projects.
Use cases covered:
- _Make Capella Objects and attributes of interest available in a Polarion_ project so that a Project User could referense those objects and attributes in LiveDocs and WorkItems such as requirements, to ensure consistency across the Project. Model has full authority over the work items that represent model elements. A change to a model element will result in a change to the corresponding WorkItem in Polarion.
- _Create and maintain LiveDocs_ based on a Capella model and a set of templates so that the Project Users could do less paperwork. A change to the model or template shall result in a change to a LiveDoc or related WorkItems. All changes to generated LiveDocs made in Polarion will be over-written by Capella2Polarion as it has "Full Authority" over those documents.
- _Create and co-maintain LiveDocs_ where model would have authority over some sections and people over other sections (mixed-authority) - this would enable Project User to create requirements or other objects in the context of model-derived structure or elements.
# Documentation
<!-- prettier-ignore -->
Read the [full documentation on GitHub](https://dsd-dbs.github.io/capella-polarion).
# Installation
We have a dependency on [cairosvg](https://cairosvg.org/). Please check their
[documentation](https://cairosvg.org/documentation/) for OS specific dependencies.
You can install the latest released version directly from [PyPI](https://pypi.org/project/capella2polarion/).
```zsh
pip install capella2polarion
```
To set up a development environment, clone the project and install it into a
virtual environment.
```zsh
git clone https://github.com/DSD-DBS/capella-polarion.git
cd capella2polarion
python -m venv .venv
source .venv/bin/activate.sh # for Linux / Mac
.venv\Scripts\activate # for Windows
pip install -U pip pre-commit
pip install -e '.[docs,test]'
pre-commit install
```
# Contributing
We'd love to see your bug reports and improvement suggestions! Please take a
look at our [guidelines for contributors](CONTRIBUTING.md) for details.
# Licenses
This project is compliant with the
[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).
Copyright DB InfraGO AG, licensed under Apache 2.0 (see full text in
[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))
Dot-files are licensed under CC0-1.0 (see full text in
[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))
Raw data
{
"_id": null,
"home_page": null,
"name": "capella2polarion",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "DB InfraGO AG",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/27/b4/ccfad1017ef39873275e4f2e636baeba66e332f4ebcc32931910744dc4fb/capella2polarion-1.4.1.tar.gz",
"platform": "any",
"description": "<!--\n ~ Copyright DB InfraGO AG and contributors\n ~ SPDX-License-Identifier: Apache-2.0\n -->\n\n# capella2polarion\n\n<!-- prettier-ignore -->\n\n\n\n\nSynchronise Capella models with Polarion projects.\n\n\n\nUse cases covered:\n\n- _Make Capella Objects and attributes of interest available in a Polarion_ project so that a Project User could referense those objects and attributes in LiveDocs and WorkItems such as requirements, to ensure consistency across the Project. Model has full authority over the work items that represent model elements. A change to a model element will result in a change to the corresponding WorkItem in Polarion.\n\n- _Create and maintain LiveDocs_ based on a Capella model and a set of templates so that the Project Users could do less paperwork. A change to the model or template shall result in a change to a LiveDoc or related WorkItems. All changes to generated LiveDocs made in Polarion will be over-written by Capella2Polarion as it has \"Full Authority\" over those documents.\n\n- _Create and co-maintain LiveDocs_ where model would have authority over some sections and people over other sections (mixed-authority) - this would enable Project User to create requirements or other objects in the context of model-derived structure or elements.\n\n# Documentation\n\n<!-- prettier-ignore -->\nRead the [full documentation on GitHub](https://dsd-dbs.github.io/capella-polarion).\n\n# Installation\n\nWe have a dependency on [cairosvg](https://cairosvg.org/). Please check their\n[documentation](https://cairosvg.org/documentation/) for OS specific dependencies.\n\nYou can install the latest released version directly from [PyPI](https://pypi.org/project/capella2polarion/).\n\n```zsh\npip install capella2polarion\n```\n\nTo set up a development environment, clone the project and install it into a\nvirtual environment.\n\n```zsh\ngit clone https://github.com/DSD-DBS/capella-polarion.git\ncd capella2polarion\npython -m venv .venv\n\nsource .venv/bin/activate.sh # for Linux / Mac\n.venv\\Scripts\\activate # for Windows\n\npip install -U pip pre-commit\npip install -e '.[docs,test]'\npre-commit install\n```\n\n# Contributing\n\nWe'd love to see your bug reports and improvement suggestions! Please take a\nlook at our [guidelines for contributors](CONTRIBUTING.md) for details.\n\n# Licenses\n\nThis project is compliant with the\n[REUSE Specification Version 3.0](https://git.fsfe.org/reuse/docs/src/commit/d173a27231a36e1a2a3af07421f5e557ae0fec46/spec.md).\n\nCopyright DB InfraGO AG, licensed under Apache 2.0 (see full text in\n[LICENSES/Apache-2.0.txt](LICENSES/Apache-2.0.txt))\n\nDot-files are licensed under CC0-1.0 (see full text in\n[LICENSES/CC0-1.0.txt](LICENSES/CC0-1.0.txt))\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Synchronise Capella models with Polarion projects",
"version": "1.4.1",
"project_urls": {
"Documentation": "https://dsd-dbs.github.io/capella2polarion",
"Homepage": "https://github.com/DSD-DBS/capella2polarion"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bcdd525fbc561b9498c218f9fadf913b3f39f35c4bd5863ad9c42426b4a8f19",
"md5": "ee541f519c8880fe6650ca64ab018aff",
"sha256": "fd8f43563d1215e54d881b634b0651ade55326835e23c00e82a7542706db421a"
},
"downloads": -1,
"filename": "capella2polarion-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee541f519c8880fe6650ca64ab018aff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 8955744,
"upload_time": "2024-12-10T17:02:42",
"upload_time_iso_8601": "2024-12-10T17:02:42.351931Z",
"url": "https://files.pythonhosted.org/packages/3b/cd/d525fbc561b9498c218f9fadf913b3f39f35c4bd5863ad9c42426b4a8f19/capella2polarion-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "27b4ccfad1017ef39873275e4f2e636baeba66e332f4ebcc32931910744dc4fb",
"md5": "ca0335ef628d1a0bcfa950e83dc464e2",
"sha256": "9608988d45aff403a804abf86a127a7d9a4a7d921b751971813000e17055ae2a"
},
"downloads": -1,
"filename": "capella2polarion-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "ca0335ef628d1a0bcfa950e83dc464e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 8936608,
"upload_time": "2024-12-10T17:02:45",
"upload_time_iso_8601": "2024-12-10T17:02:45.485887Z",
"url": "https://files.pythonhosted.org/packages/27/b4/ccfad1017ef39873275e4f2e636baeba66e332f4ebcc32931910744dc4fb/capella2polarion-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 17:02:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DSD-DBS",
"github_project": "capella2polarion",
"github_not_found": true,
"lcname": "capella2polarion"
}
