| Name | python-package-template-pypi JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A github template with my python package configurations. |
| upload_time | 2024-08-10 13:54:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 Daniel Mizsak Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
github
package
pypi
python
template
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## <div align="center"> 🐍 python-package-template</div>
<div align="center">
<a href="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
<a href="https://codecov.io/gh/daniel-mizsak/python-package-template" target="_blank"><img src="https://codecov.io/gh/daniel-mizsak/python-package-template/graph/badge.svg?token=SDXG1S8PVM"/></a>
<a href="https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main" target="_blank"><img src="https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg" alt="pre-commit.ci status"></a>
<a href='https://python-package-template-pypi.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/python-package-template-pypi/badge/?version=latest' alt='docs status' /></a>
<a href="https://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
</div>
## Overview
A GitHub template with my python package configurations.
## Package tools
This template package relies on the synchronized cooperation of several exceptional tools.\
These tools include:
- [Codecov](https://docs.codecov.com/docs/quick-start) - Code coverage
- [Pre-Commit](https://pre-commit.com/) - Git hooks running on commits
- [Hatch](https://hatch.pypa.io/latest/) - Package building
- [MyPy](https://mypy.readthedocs.io/en/stable/) - Static type checking
- [Pytest](https://docs.pytest.org/en/latest/) - Testing and code coverage
- [Ruff](https://docs.astral.sh/ruff/) - Formatting and linting
- [Tox](https://tox.readthedocs.io/en/latest/) - Orchestration of the above tools
For documentation:
- [Sphinx](https://www.sphinx-doc.org/en/master/) - Documentation building
- [ReadTheDocs](https://readthedocs.org/) - Documentation hosting
- [GitHub Pages](https://pages.github.com/) - Documentation hosting
### Codecov
Codecov is used to check the code coverage of the tests.\
It also provides a badge that can be added to the README file.
Codecov is set up to be part of the [tox reusable workflow](https://github.com/daniel-mizsak/workflows/blob/main/.github/workflows/tox.yml), but for this action it is important to generate the coverage report using the `--cov-report=xml` flag in the `pyproject.toml` file.
### Pre-Commit
Pre-Commit is used to run certain checks on the code before it is committed.\
These checks are defined in the `.pre-commit-config.yaml` file.\
To use pre-commit is has to be installed in the virtual environment and also added to the git hooks by running `pre-commit install`.
In this repository pre-commit is set up for a number of general issues and to run formatting and linting checks with `ruff`.
### Hatch
Hatch is primarily used to build the package, but it can also be used to run certain tests in isolated environments.\
If the package building is more complex and requires additional settings or files it is recommended to read the hatch documentation.\
In this repository hatch is set up with the local path of the package as it differs from the one specified in the `pyproject.toml` file which is used for publishing to PyPI.
The isolated environment settings for hatch are defined in the `hatch.toml` file.\
I was thinking about replacing `tox` with `hatch`, but for now `tox` fits more into my workflows.
### MyPy
Python by default is a dynamically typed language, but being explicit about types can help to avoid bugs.\
MyPy makes sure that the types are correct and consistent throughout the code.
The `mypy` related settings are defined in the `pyproject.toml` file.\
In this repository MyPy is set up be `strict` and it also checks for some additional issues.
### Pytest
Pytest is a modern testing framework for Python.\
It is way too complex to explain it here, but it runs all the tests from the `tests` directory and also checks the code coverage.
Its settings are defined in the `pyproject.toml` file.
### Ruff
Ruff is a formatter and linter that is built on top of a lot of open source tools.\
It is very fast and unifies all the useful code quality solutions into a single tool.\
By default it is not too strict, but I like to make it strict by selecting all the available rules.
The exact configuration is defined in the `ruff.toml` file.
If for some reason it makes sense not to comply with a certain rule, it can be disabled for that line using `# noqa: <rule number>`.
### Tox
Tox is useful for running the above tools in an isolated environment.\
It makes sure that the package setup is consistent and that the tools are working as expected.\
It can be used to test different Python versions and different testing scenarios.
In this repository tox is set up to use python 3.12 and run pytest, ruff, mypy and documentation tests.
The settings are specified in the `tox.ini` file.
### Documentation
The documentation is built with Sphinx and it is hosted both on ReadTheDocs and GitHub Pages.\
Both of these services are recommended, however ReadTheDocs requires a bit more setup, but I prefer it as it does not require an extra feature branch to be present.
## GitHub repository settings
The following settings are enabled in my repository settings:
Code/About:
- Releases
<br>
General/Features:
- Issues
- Preserve this repository
<br>
General/Pull Requests:
- Allow merge commits
- Allow squash merging
- Allow rebase merging
- Automatically delete head branches
<br>
Branches/Branch protection rules:\
`main`\
Protect matching branches
- Require pull request reviews before merging
- Dismiss stale pull request approvals when new commits are pushed
- Require status checks to pass before merging
- `pre-commit.ci - pr`
- `tox / tox`
- Do not allow bypassing the above settings
<br>
Environments:\
`pypi`
- Deployment protection rules:
- Required reviewers:
`daniel-mizsak`
- Allow administrators to bypass configured protection rules
<br>
Pages/Build and deployment:
- Source: Deploy from branch
- Branch: `gh-pages` (root)
## Setup PyPi trusted publishing
[PyPI publishing settings](https://pypi.org/manage/account/publishing/)
Add a new pending publisher:
- PyPI Project Name: `python-package-template-pypi` (has to match the project name in `pyproject.toml`)
- Owner: `daniel-mizsak`
- Repository name: `python-package-template`
- Workflow name: `release.yml`
Raw data
{
"_id": null,
"home_page": null,
"name": "python-package-template-pypi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "github, package, pypi, python, template",
"author": null,
"author_email": "Daniel Mizsak <info@pythonvilag.hu>",
"download_url": "https://files.pythonhosted.org/packages/80/b0/069ec86c5c4e91991b939ccb7a335c1741e66ae685fdcfc32e029dba8363/python_package_template_pypi-0.1.1.tar.gz",
"platform": null,
"description": "## <div align=\"center\"> \ud83d\udc0d python-package-template</div>\n\n<div align=\"center\">\n<a href=\"https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml\" target=\"_blank\"><img src=\"https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg\" alt=\"build status\"></a>\n<a href=\"https://codecov.io/gh/daniel-mizsak/python-package-template\" target=\"_blank\"><img src=\"https://codecov.io/gh/daniel-mizsak/python-package-template/graph/badge.svg?token=SDXG1S8PVM\"/></a>\n<a href=\"https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main\" target=\"_blank\"><img src=\"https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg\" alt=\"pre-commit.ci status\"></a>\n<a href='https://python-package-template-pypi.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/python-package-template-pypi/badge/?version=latest' alt='docs status' /></a>\n<a href=\"https://img.shields.io/github/license/daniel-mizsak/python-package-template\" target=\"_blank\"><img src=\"https://img.shields.io/github/license/daniel-mizsak/python-package-template\" alt=\"license\"></a>\n</div>\n\n## Overview\nA GitHub template with my python package configurations.\n\n## Package tools\nThis template package relies on the synchronized cooperation of several exceptional tools.\\\nThese tools include:\n- [Codecov](https://docs.codecov.com/docs/quick-start) - Code coverage\n- [Pre-Commit](https://pre-commit.com/) - Git hooks running on commits\n- [Hatch](https://hatch.pypa.io/latest/) - Package building\n- [MyPy](https://mypy.readthedocs.io/en/stable/) - Static type checking\n- [Pytest](https://docs.pytest.org/en/latest/) - Testing and code coverage\n- [Ruff](https://docs.astral.sh/ruff/) - Formatting and linting\n- [Tox](https://tox.readthedocs.io/en/latest/) - Orchestration of the above tools\n\nFor documentation:\n- [Sphinx](https://www.sphinx-doc.org/en/master/) - Documentation building\n- [ReadTheDocs](https://readthedocs.org/) - Documentation hosting\n- [GitHub Pages](https://pages.github.com/) - Documentation hosting\n\n### Codecov\nCodecov is used to check the code coverage of the tests.\\\nIt also provides a badge that can be added to the README file.\n\nCodecov is set up to be part of the [tox reusable workflow](https://github.com/daniel-mizsak/workflows/blob/main/.github/workflows/tox.yml), but for this action it is important to generate the coverage report using the `--cov-report=xml` flag in the `pyproject.toml` file.\n\n### Pre-Commit\nPre-Commit is used to run certain checks on the code before it is committed.\\\nThese checks are defined in the `.pre-commit-config.yaml` file.\\\nTo use pre-commit is has to be installed in the virtual environment and also added to the git hooks by running `pre-commit install`.\n\nIn this repository pre-commit is set up for a number of general issues and to run formatting and linting checks with `ruff`.\n\n### Hatch\nHatch is primarily used to build the package, but it can also be used to run certain tests in isolated environments.\\\nIf the package building is more complex and requires additional settings or files it is recommended to read the hatch documentation.\\\nIn this repository hatch is set up with the local path of the package as it differs from the one specified in the `pyproject.toml` file which is used for publishing to PyPI.\n\nThe isolated environment settings for hatch are defined in the `hatch.toml` file.\\\nI was thinking about replacing `tox` with `hatch`, but for now `tox` fits more into my workflows.\n\n### MyPy\nPython by default is a dynamically typed language, but being explicit about types can help to avoid bugs.\\\nMyPy makes sure that the types are correct and consistent throughout the code.\n\nThe `mypy` related settings are defined in the `pyproject.toml` file.\\\nIn this repository MyPy is set up be `strict` and it also checks for some additional issues.\n\n### Pytest\nPytest is a modern testing framework for Python.\\\nIt is way too complex to explain it here, but it runs all the tests from the `tests` directory and also checks the code coverage.\n\nIts settings are defined in the `pyproject.toml` file.\n\n### Ruff\nRuff is a formatter and linter that is built on top of a lot of open source tools.\\\nIt is very fast and unifies all the useful code quality solutions into a single tool.\\\nBy default it is not too strict, but I like to make it strict by selecting all the available rules.\nThe exact configuration is defined in the `ruff.toml` file.\n\nIf for some reason it makes sense not to comply with a certain rule, it can be disabled for that line using `# noqa: <rule number>`.\n\n### Tox\nTox is useful for running the above tools in an isolated environment.\\\nIt makes sure that the package setup is consistent and that the tools are working as expected.\\\nIt can be used to test different Python versions and different testing scenarios.\n\nIn this repository tox is set up to use python 3.12 and run pytest, ruff, mypy and documentation tests.\nThe settings are specified in the `tox.ini` file.\n\n### Documentation\nThe documentation is built with Sphinx and it is hosted both on ReadTheDocs and GitHub Pages.\\\nBoth of these services are recommended, however ReadTheDocs requires a bit more setup, but I prefer it as it does not require an extra feature branch to be present.\n\n## GitHub repository settings\nThe following settings are enabled in my repository settings:\n\nCode/About:\n\n- Releases\n\n<br>\n\nGeneral/Features:\n\n- Issues\n- Preserve this repository\n\n<br>\n\nGeneral/Pull Requests:\n\n- Allow merge commits\n- Allow squash merging\n- Allow rebase merging\n- Automatically delete head branches\n\n<br>\n\nBranches/Branch protection rules:\\\n`main`\\\nProtect matching branches\n\n- Require pull request reviews before merging\n- Dismiss stale pull request approvals when new commits are pushed\n- Require status checks to pass before merging\n - `pre-commit.ci - pr`\n - `tox / tox`\n- Do not allow bypassing the above settings\n\n<br>\n\nEnvironments:\\\n`pypi`\n\n- Deployment protection rules:\n- Required reviewers:\n `daniel-mizsak`\n- Allow administrators to bypass configured protection rules\n\n<br>\n\nPages/Build and deployment:\n\n- Source: Deploy from branch\n- Branch: `gh-pages` (root)\n\n## Setup PyPi trusted publishing\n\n[PyPI publishing settings](https://pypi.org/manage/account/publishing/)\n\nAdd a new pending publisher:\n\n- PyPI Project Name: `python-package-template-pypi` (has to match the project name in `pyproject.toml`)\n- Owner: `daniel-mizsak`\n- Repository name: `python-package-template`\n- Workflow name: `release.yml`\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Daniel Mizsak Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A github template with my python package configurations.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://python-package-template-pypi.readthedocs.io/en/latest/",
"Homepage": "https://pythonvilag.hu/",
"Issues": "https://github.com/daniel-mizsak/python-package-template/issues",
"Repository": "https://github.com/daniel-mizsak/python-package-template"
},
"split_keywords": [
"github",
" package",
" pypi",
" python",
" template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "426f233e6314c7bca433cd6c1327905f28bb0c84ee77c714f2c9c4b813710b0a",
"md5": "0bd64d7551df55bab6a211a18f34f4f1",
"sha256": "754ffaa0bf385990da8ff5444d481940f83fc2aa53126fbffb20b88721e083fd"
},
"downloads": -1,
"filename": "python_package_template_pypi-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bd64d7551df55bab6a211a18f34f4f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7326,
"upload_time": "2024-08-10T13:54:53",
"upload_time_iso_8601": "2024-08-10T13:54:53.046494Z",
"url": "https://files.pythonhosted.org/packages/42/6f/233e6314c7bca433cd6c1327905f28bb0c84ee77c714f2c9c4b813710b0a/python_package_template_pypi-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80b0069ec86c5c4e91991b939ccb7a335c1741e66ae685fdcfc32e029dba8363",
"md5": "e7e35b3de3d1d779463ea9bfe6b6f1b7",
"sha256": "bea6df77d77f20039e56c7b0c916eb9311b522654d92cdb0c6130fa49340f538"
},
"downloads": -1,
"filename": "python_package_template_pypi-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e7e35b3de3d1d779463ea9bfe6b6f1b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9267,
"upload_time": "2024-08-10T13:54:54",
"upload_time_iso_8601": "2024-08-10T13:54:54.434964Z",
"url": "https://files.pythonhosted.org/packages/80/b0/069ec86c5c4e91991b939ccb7a335c1741e66ae685fdcfc32e029dba8363/python_package_template_pypi-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-10 13:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daniel-mizsak",
"github_project": "python-package-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "python-package-template-pypi"
}
