# 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_client.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
gitGraph
commit
branch staging
branch feature/some-feature
checkout feature/some-feature
commit
commit
checkout staging
merge feature/some-feature id: "Test PyPI"
checkout main
merge staging id: "Release in PyPI" tag: "v0.1.0"
branch fix/some-fix
checkout fix/some-fix
commit
checkout staging
merge fix/some-fix id: "Test PyPI again"
checkout main
merge staging id: "New fix release in PyPI" tag: "v0.1.1"
```
## Deployment
Using Github Actions. See `.github/worfklows/`
Raw data
{
"_id": null,
"home_page": "https://github.com/qurixtechnology/python-package-template",
"name": "qurix-package-template",
"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/e7/8d/259e6537160764699caca719b23808986a162a983cdcd83ae5b009321747/qurix-package-template-1.0.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_client.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\ngitGraph\n commit\n branch staging\n branch feature/some-feature\n checkout feature/some-feature\n commit\n commit\n checkout staging\n merge feature/some-feature id: \"Test PyPI\"\n checkout main\n merge staging id: \"Release in PyPI\" 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: \"Test PyPI again\"\n checkout main\n merge staging id: \"New fix release in PyPI\" tag: \"v0.1.1\"\n```\n\n## Deployment\n\nUsing Github Actions. See `.github/worfklows/`\n",
"bugtrack_url": null,
"license": "",
"summary": "qurix Package Template for Python",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/qurixtechnology/python-package-template"
},
"split_keywords": [
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "178c51c54e76385f96771ae5bd43f22d7c1173dd3106d92f11ef755b209a3344",
"md5": "482ff2e267f56dfe6b61742c0e969168",
"sha256": "2e5c80c591bb7f7a08d3570de4c22d8deb851e0703b18e38a773817352cee003"
},
"downloads": -1,
"filename": "qurix_package_template-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "482ff2e267f56dfe6b61742c0e969168",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10, <4",
"size": 3115,
"upload_time": "2023-06-27T08:35:55",
"upload_time_iso_8601": "2023-06-27T08:35:55.849366Z",
"url": "https://files.pythonhosted.org/packages/17/8c/51c54e76385f96771ae5bd43f22d7c1173dd3106d92f11ef755b209a3344/qurix_package_template-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e78d259e6537160764699caca719b23808986a162a983cdcd83ae5b009321747",
"md5": "8242f69b67ee5fa378eaca92179af9db",
"sha256": "2c6f4f24cdf4d6ca323e5856ea2741cde11eff9fc32ce150f98b03d7a6d1b145"
},
"downloads": -1,
"filename": "qurix-package-template-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8242f69b67ee5fa378eaca92179af9db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10, <4",
"size": 2452,
"upload_time": "2023-06-27T08:35:57",
"upload_time_iso_8601": "2023-06-27T08:35:57.256846Z",
"url": "https://files.pythonhosted.org/packages/e7/8d/259e6537160764699caca719b23808986a162a983cdcd83ae5b009321747/qurix-package-template-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 08:35:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qurixtechnology",
"github_project": "python-package-template",
"github_not_found": true,
"lcname": "qurix-package-template"
}