# Python package template
Template for Python packages for qurix Technology.
## Structure
A normal Python package will start with the namespace `qurix` as in this sample package. A sample structure is as follows:
```text
.
├── LICENCE
├── Makefile
├── README.md
├── qurix
│ └── <domain>
│ └── <module-organization-level>
│ ├── __init__.py
│ ├── __version__.py
│ └── <module>
├── requirements.txt
├── setup.py
└── tests
├── __init__.py
└── test_module.py
```
## Versioning and release
Package versions will be identified according to [semantic versioning](https://semver.org/lang/en). The release process will deploy in both [Test PyPI](https://test.pypi.org/) and [PyPI](https://pypi.org/).
```mermaid
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': true}} }%%
gitGraph
commit
branch staging
branch feat/some-feature
checkout feat/some-feature
commit
commit
checkout staging
merge feat/some-feature id: "Rel. Test PyPI 0" tag: "v0.1.0rc0"
checkout main
merge staging id: "Rel. PyPI 0" tag: "v0.1.0"
branch fix/some-fix
checkout fix/some-fix
commit
checkout staging
merge fix/some-fix id: "Rel. Test PyPI 1" tag: "v0.1.1rc0"
checkout main
merge staging id: "Rel. PyPI 1" tag: "v0.1.1"
```
## Deployment
Automatic deployments via Github Actions. See `.github/worfklows/`
Raw data
{
"_id": null,
"home_page": "https://github.com/qurixtechnology/qurix-sample-package",
"name": "qurix-sample-package",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10, <4",
"maintainer_email": "",
"keywords": "python",
"author": "qurix Technology",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7e/16/3ce5a2d673b60f1bb93a17c4adf7484eafa5d987a2804f3456a5128d172d/qurix-sample-package-0.5.0.tar.gz",
"platform": null,
"description": "# Python package template\n\nTemplate for Python packages for qurix Technology.\n\n## Structure\n\nA normal Python package will start with the namespace `qurix` as in this sample package. A sample structure is as follows:\n\n```text\n.\n\u251c\u2500\u2500 LICENCE\n\u251c\u2500\u2500 Makefile\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 qurix\n\u2502 \u2514\u2500\u2500 <domain>\n\u2502 \u2514\u2500\u2500 <module-organization-level>\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u251c\u2500\u2500 __version__.py\n\u2502 \u2514\u2500\u2500 <module>\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 tests\n \u251c\u2500\u2500 __init__.py\n \u2514\u2500\u2500 test_module.py\n```\n\n## Versioning and release\n\nPackage versions will be identified according to [semantic versioning](https://semver.org/lang/en). The release process will deploy in both [Test PyPI](https://test.pypi.org/) and [PyPI](https://pypi.org/).\n\n```mermaid\n%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'rotateCommitLabel': true}} }%%\ngitGraph\n commit\n branch staging\n branch feat/some-feature\n checkout feat/some-feature\n commit\n commit\n checkout staging\n merge feat/some-feature id: \"Rel. Test PyPI 0\" tag: \"v0.1.0rc0\"\n checkout main\n merge staging id: \"Rel. PyPI 0\" tag: \"v0.1.0\"\n branch fix/some-fix\n checkout fix/some-fix\n commit\n checkout staging\n merge fix/some-fix id: \"Rel. Test PyPI 1\" tag: \"v0.1.1rc0\"\n checkout main\n merge staging id: \"Rel. PyPI 1\" tag: \"v0.1.1\"\n```\n\n## Deployment\n\nAutomatic deployments via Github Actions. See `.github/worfklows/`\n",
"bugtrack_url": null,
"license": "",
"summary": "qurix Package Template for Python",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/qurixtechnology/qurix-sample-package"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b480f1d31729fc7c78cdbcdb21dfa05185a3f6a309d1b1f582f7fae38455bbc",
"md5": "757089f45563efd1e4d3da46c043ee9d",
"sha256": "6917b0333bb020b310648efbb546f914079f09a4aaf2f751207e3cc7899632ec"
},
"downloads": -1,
"filename": "qurix_sample_package-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "757089f45563efd1e4d3da46c043ee9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10, <4",
"size": 3995,
"upload_time": "2023-10-10T14:41:14",
"upload_time_iso_8601": "2023-10-10T14:41:14.030655Z",
"url": "https://files.pythonhosted.org/packages/3b/48/0f1d31729fc7c78cdbcdb21dfa05185a3f6a309d1b1f582f7fae38455bbc/qurix_sample_package-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e163ce5a2d673b60f1bb93a17c4adf7484eafa5d987a2804f3456a5128d172d",
"md5": "83dce65e38d01719d1143a7e5fa8f5ed",
"sha256": "215b96ed86f2cbfab5564f20623af6bbef3693e1a535d48ac27f38a09de528a9"
},
"downloads": -1,
"filename": "qurix-sample-package-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "83dce65e38d01719d1143a7e5fa8f5ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10, <4",
"size": 3190,
"upload_time": "2023-10-10T14:41:15",
"upload_time_iso_8601": "2023-10-10T14:41:15.319219Z",
"url": "https://files.pythonhosted.org/packages/7e/16/3ce5a2d673b60f1bb93a17c4adf7484eafa5d987a2804f3456a5128d172d/qurix-sample-package-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 14:41:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qurixtechnology",
"github_project": "qurix-sample-package",
"github_not_found": true,
"lcname": "qurix-sample-package"
}
JSON
