# rest-api
Rest-API Plugin for Architecture-as-Code
## PYTHON VERSION COMPATIBILITY
Currently, Python version 3.9.13 is required to avoid certain dependency version issues.
## pyproject.toml vs setup.py
Previously, this project was built with dependency information kept in a setup.py script.
However, the preferred method is to use pyproject.toml to set the project-level options.
Required modules are kept in the dependency sections of the pyproject.toml, and then the
pip-compile command is used to add hashes to the requirements.txt file for enhanced security
(see additional instructions below).
To coincide with these changes, some changes to tox.ini and the addition of a MANIFEST.ini file were also necessary.
These lines were added to tox.ini:
isolated_build = True
skipsdist = True
A MANIFEST file with these lines was added:
graft src
graft tests
include tox.ini
include src/rest-api/.aac
## TO BUILD FROM TERMINAL
cd python
pip install -e .
## TO TEST FROM TERMINAL
cd python
pip install -e .
python -m unittest
## Generate a requirements.txt file populated with hashes
pip install pip-tools
pip-compile --generate-hashes pyproject.toml
Raw data
{
"_id": null,
"home_page": null,
"name": "aac-rest-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.13",
"maintainer_email": null,
"keywords": "SysML, Architecture-as-Code, System Engineering, MBSE",
"author": null,
"author_email": "AaC Dev Team <asdfasdaf@email.com>",
"download_url": "https://files.pythonhosted.org/packages/16/a5/9eef2213b22325380a4e1779b1b6708a59fed883b7c5723d58c2dacc1d34/aac_rest_api-0.1.6.tar.gz",
"platform": null,
"description": "# rest-api\n\nRest-API Plugin for Architecture-as-Code\n\n## PYTHON VERSION COMPATIBILITY\n\nCurrently, Python version 3.9.13 is required to avoid certain dependency version issues.\n\n## pyproject.toml vs setup.py\n\nPreviously, this project was built with dependency information kept in a setup.py script.\nHowever, the preferred method is to use pyproject.toml to set the project-level options.\nRequired modules are kept in the dependency sections of the pyproject.toml, and then the\npip-compile command is used to add hashes to the requirements.txt file for enhanced security\n(see additional instructions below).\n\nTo coincide with these changes, some changes to tox.ini and the addition of a MANIFEST.ini file were also necessary.\n\nThese lines were added to tox.ini:\n isolated_build = True\n skipsdist = True\n\nA MANIFEST file with these lines was added:\n graft src\n graft tests\n include tox.ini\n include src/rest-api/.aac\n\n## TO BUILD FROM TERMINAL\n\ncd python\npip install -e .\n\n## TO TEST FROM TERMINAL\n\ncd python\npip install -e .\npython -m unittest\n\n## Generate a requirements.txt file populated with hashes\n\npip install pip-tools\npip-compile --generate-hashes pyproject.toml\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Rest-API Plugin for AaC",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/DevOps-MBSE/aac-rest-api",
"Issues": "https://github.com/DevOps-MBSE/aac-rest-api/issues"
},
"split_keywords": [
"sysml",
" architecture-as-code",
" system engineering",
" mbse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2aa7cf890093b2608a925d8242f49415fa16800e4efa6f91e39651d68224489e",
"md5": "3d2b130c2615b05f6866e05b4805e03f",
"sha256": "62b8b1a19a7fe2a4fcd53e4790156917fae4cf9a3039b45e93847bf51684ff0f"
},
"downloads": -1,
"filename": "aac_rest_api-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d2b130c2615b05f6866e05b4805e03f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.13",
"size": 12967,
"upload_time": "2024-12-04T03:26:17",
"upload_time_iso_8601": "2024-12-04T03:26:17.927313Z",
"url": "https://files.pythonhosted.org/packages/2a/a7/cf890093b2608a925d8242f49415fa16800e4efa6f91e39651d68224489e/aac_rest_api-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16a59eef2213b22325380a4e1779b1b6708a59fed883b7c5723d58c2dacc1d34",
"md5": "dadc704ef4ff8ffbbd20a259a8f6d917",
"sha256": "d49a4fece4ad235ada3144340e02ae6209cc4d09b22b9497596ce97d27e5f798"
},
"downloads": -1,
"filename": "aac_rest_api-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "dadc704ef4ff8ffbbd20a259a8f6d917",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.13",
"size": 17475,
"upload_time": "2024-12-04T03:26:20",
"upload_time_iso_8601": "2024-12-04T03:26:20.055343Z",
"url": "https://files.pythonhosted.org/packages/16/a5/9eef2213b22325380a4e1779b1b6708a59fed883b7c5723d58c2dacc1d34/aac_rest_api-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 03:26:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DevOps-MBSE",
"github_project": "aac-rest-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aac-rest-api"
}
JSON
