# Learn Python Packaging
[![codecov][codecov-badge-image]][codecov-badge-url]
[![DeepSource][deepsource-badge-image]][deepsource-badge-url]
[![Documentation Status][read-the-docs-badge-image]][read-the-docs-badge-url]
[![code-quality workflow][code-quality-workflow-badge-image]][code-quality-workflow-badge-url]
[![docs workflow][docs-workflow-badge-image]][docs-workflow-badge-url]
[![format workflow][format-workflow-badge-image]][format-workflow-badge-url]
[![lint workflow][lint-workflow-badge-image]][lint-workflow-badge-url]
[![release workflow][release-workflow-badge-image]][release-workflow-badge-url]
[![test workflow][test-workflow-badge-image]][test-workflow-badge-url]
[![pre-commit][pre-commit-badge-image]][pre-commit-badge-url]
[![Ruff][ruff-badge-image]][ruff-badge-url]
[![Code style: black][black-badge-image]][black-badge-url]
[![Docstring formatter: docformatter][docformatter-badge-image]][docformatter-badge-url]
[![Imports: isort][isort-badge-image]][isort-badge-url]
[![security: bandit][bandit-badge-image]][bandit-badge-url]
[![linting: pylint][pylint-badge-image]][pylint-badge-url]
[![Docstring style: numpy][numpydoc-badge-image]][numpydoc-badge-url]
- [x] ~~Create Python Package~~
- [x] ~~Build Wheel~~
- [x] ~~Release Wheel~~
- [x] ~~Setup Github Actions~~
- [x] ~~Host Documentation~~
- [x] ~~Hypotheses Testing~~
- [x] ~~Pydantic Validation~~
- [x] ~~Support Expressions~~
- [ ] Bump Workflow
## Tools Used
- Development
- [codespell](https://github.com/codespell-project/codespell)
- [Nox](https://github.com/wntrblm/nox)
- [numpydoc](https://numpydoc.readthedocs.io/)
- [pre-commit](https://github.com/pre-commit/pre-commit)
- [Ruff](https://github.com/astral-sh/ruff)
- Formatting
- [autoflake](https://www.github.com/PyCQA/autoflake)
- [Black](https://github.com/psf/black)
- [blacken-docs](https://github.com/adamchainz/blacken-docs)
- [docformatter](https://github.com/PyCQA/docformatter)
- [isort](https://pycqa.github.io/isort/)
- [pyproject-fmt](https://github.com/tox-dev/pyproject-fmt)
- [pyupgrade](https://github.com/asottile/pyupgrade)
- Linting
- [Bandit](https://bandit.readthedocs.io/)
- [Flake8](https://github.com/pycqa/flake8)
- [interrogate](https://interrogate.readthedocs.io/)
- [Mypy](http://www.mypy-lang.org/)
- [pydocstyle](https://www.pydocstyle.org/en/stable/)
- [Pylint](https://github.com/PyCQA/pylint)
- [Pyright for Python](https://github.com/RobertCraigie/pyright-python)
- [validate-pyproject](https://github.com/abravalheri/validate-pyproject/)
- [Vulture](https://github.com/jendrikseipp/vulture)
- Testing
- [Coverage.py](https://github.com/nedbat/coveragepy)
- [Hypothesis](https://hypothesis.works/)
- [pytest](https://docs.pytest.org/en/latest/)
- Documentation
- [Furo](https://github.com/pradyunsg/furo)
- [Read the Docs](https://readthedocs.org/)
- [Sphinx](https://www.sphinx-doc.org/)
- [sphinx-copybutton](https://github.com/executablebooks/sphinx-copybutton)
[bandit-badge-image]: https://img.shields.io/badge/security-bandit-yellow.svg
[bandit-badge-url]: https://github.com/PyCQA/bandit
[black-badge-image]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-badge-url]: https://github.com/psf/black
[code-quality-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/code-quality.yml/badge.svg
[code-quality-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/code-quality.yml/
[codecov-badge-image]: https://codecov.io/gh/yarnabrina/learn-python-packaging/branch/main/graph/badge.svg?token=BG1ECA7E14
[codecov-badge-url]: https://codecov.io/gh/yarnabrina/learn-python-packaging
[docformatter-badge-image]: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
[docformatter-badge-url]: https://github.com/PyCQA/docformatter
[deepsource-badge-image]: https://deepsource.io/gh/yarnabrina/learn-python-packaging.svg/?label=active+issues&token=tfsfTm2RCqlPTgF3dN31q-0e
[deepsource-badge-url]: https://deepsource.io/gh/yarnabrina/learn-python-packaging/?ref=repository-badge
[docs-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/docs.yml/badge.svg
[docs-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/docs.yml/
[format-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/format.yml/badge.svg
[format-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/format.yml/
[isort-badge-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
[isort-badge-url]: https://pycqa.github.io/isort/
[lint-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/lint.yml/badge.svg
[lint-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/lint.yml/
[numpydoc-badge-image]: https://img.shields.io/badge/%20style-numpy-459db9.svg
[numpydoc-badge-url]: https://numpydoc.readthedocs.io/en/latest/format.html
[pre-commit-badge-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
[pre-commit-badge-url]: https://github.com/pre-commit/pre-commit
[pylint-badge-image]: https://img.shields.io/badge/linting-pylint-yellowgreen
[pylint-badge-url]: https://github.com/PyCQA/pylint
[read-the-docs-badge-image]: https://readthedocs.org/projects/learn-python-packaging/badge/?version=latest
[read-the-docs-badge-url]: https://learn-python-packaging.readthedocs.io/en/latest/?badge=latest
[release-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/release.yml/badge.svg
[release-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/release.yml/
[ruff-badge-image]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
[ruff-badge-url]: https://github.com/astral-sh/ruff
[test-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/test.yml/badge.svg
[test-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/test.yml/
Raw data
{
"_id": null,
"home_page": "",
"name": "package-name-to-install-with",
"maintainer": "Anirban Ray",
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "39331844+yarnabrina@users.noreply.github.com, First Maintainer <first.maintainer@example.com>, Second Maintainer <second.maintainer@example.com>",
"keywords": "development,packaging,sample,setuptools",
"author": "Anirban Ray",
"author_email": "39331844+yarnabrina@users.noreply.github.com, First Author <first.author@example.com>, Second Author <second.author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/a3/18/5cf31ead3fed091c8a435a5e6f56d35c3c42e4b920a6d1928f9c046ecb83/package-name-to-install-with-0.0.5.tar.gz",
"platform": null,
"description": "# Learn Python Packaging\n\n[![codecov][codecov-badge-image]][codecov-badge-url]\n[![DeepSource][deepsource-badge-image]][deepsource-badge-url]\n[![Documentation Status][read-the-docs-badge-image]][read-the-docs-badge-url]\n\n[![code-quality workflow][code-quality-workflow-badge-image]][code-quality-workflow-badge-url]\n[![docs workflow][docs-workflow-badge-image]][docs-workflow-badge-url]\n[![format workflow][format-workflow-badge-image]][format-workflow-badge-url]\n[![lint workflow][lint-workflow-badge-image]][lint-workflow-badge-url]\n[![release workflow][release-workflow-badge-image]][release-workflow-badge-url]\n[![test workflow][test-workflow-badge-image]][test-workflow-badge-url]\n\n[![pre-commit][pre-commit-badge-image]][pre-commit-badge-url]\n[![Ruff][ruff-badge-image]][ruff-badge-url]\n\n[![Code style: black][black-badge-image]][black-badge-url]\n[![Docstring formatter: docformatter][docformatter-badge-image]][docformatter-badge-url]\n[![Imports: isort][isort-badge-image]][isort-badge-url]\n\n[![security: bandit][bandit-badge-image]][bandit-badge-url]\n[![linting: pylint][pylint-badge-image]][pylint-badge-url]\n\n[![Docstring style: numpy][numpydoc-badge-image]][numpydoc-badge-url]\n\n- [x] ~~Create Python Package~~\n- [x] ~~Build Wheel~~\n- [x] ~~Release Wheel~~\n- [x] ~~Setup Github Actions~~\n- [x] ~~Host Documentation~~\n- [x] ~~Hypotheses Testing~~\n- [x] ~~Pydantic Validation~~\n- [x] ~~Support Expressions~~\n- [ ] Bump Workflow\n\n## Tools Used\n\n- Development\n - [codespell](https://github.com/codespell-project/codespell)\n - [Nox](https://github.com/wntrblm/nox)\n - [numpydoc](https://numpydoc.readthedocs.io/)\n - [pre-commit](https://github.com/pre-commit/pre-commit)\n - [Ruff](https://github.com/astral-sh/ruff)\n- Formatting\n - [autoflake](https://www.github.com/PyCQA/autoflake)\n - [Black](https://github.com/psf/black)\n - [blacken-docs](https://github.com/adamchainz/blacken-docs)\n - [docformatter](https://github.com/PyCQA/docformatter)\n - [isort](https://pycqa.github.io/isort/)\n - [pyproject-fmt](https://github.com/tox-dev/pyproject-fmt)\n - [pyupgrade](https://github.com/asottile/pyupgrade)\n- Linting\n - [Bandit](https://bandit.readthedocs.io/)\n - [Flake8](https://github.com/pycqa/flake8)\n - [interrogate](https://interrogate.readthedocs.io/)\n - [Mypy](http://www.mypy-lang.org/)\n - [pydocstyle](https://www.pydocstyle.org/en/stable/)\n - [Pylint](https://github.com/PyCQA/pylint)\n - [Pyright for Python](https://github.com/RobertCraigie/pyright-python)\n - [validate-pyproject](https://github.com/abravalheri/validate-pyproject/)\n - [Vulture](https://github.com/jendrikseipp/vulture)\n- Testing\n - [Coverage.py](https://github.com/nedbat/coveragepy)\n - [Hypothesis](https://hypothesis.works/)\n - [pytest](https://docs.pytest.org/en/latest/)\n- Documentation\n - [Furo](https://github.com/pradyunsg/furo)\n - [Read the Docs](https://readthedocs.org/)\n - [Sphinx](https://www.sphinx-doc.org/)\n - [sphinx-copybutton](https://github.com/executablebooks/sphinx-copybutton)\n\n[bandit-badge-image]: https://img.shields.io/badge/security-bandit-yellow.svg\n[bandit-badge-url]: https://github.com/PyCQA/bandit\n\n[black-badge-image]: https://img.shields.io/badge/code%20style-black-000000.svg\n[black-badge-url]: https://github.com/psf/black\n\n[code-quality-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/code-quality.yml/badge.svg\n[code-quality-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/code-quality.yml/\n\n[codecov-badge-image]: https://codecov.io/gh/yarnabrina/learn-python-packaging/branch/main/graph/badge.svg?token=BG1ECA7E14\n[codecov-badge-url]: https://codecov.io/gh/yarnabrina/learn-python-packaging\n\n[docformatter-badge-image]: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg\n[docformatter-badge-url]: https://github.com/PyCQA/docformatter\n\n[deepsource-badge-image]: https://deepsource.io/gh/yarnabrina/learn-python-packaging.svg/?label=active+issues&token=tfsfTm2RCqlPTgF3dN31q-0e\n[deepsource-badge-url]: https://deepsource.io/gh/yarnabrina/learn-python-packaging/?ref=repository-badge\n\n[docs-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/docs.yml/badge.svg\n[docs-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/docs.yml/\n\n[format-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/format.yml/badge.svg\n[format-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/format.yml/\n\n[isort-badge-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n[isort-badge-url]: https://pycqa.github.io/isort/\n\n[lint-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/lint.yml/badge.svg\n[lint-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/lint.yml/\n\n[numpydoc-badge-image]: https://img.shields.io/badge/%20style-numpy-459db9.svg\n[numpydoc-badge-url]: https://numpydoc.readthedocs.io/en/latest/format.html\n\n[pre-commit-badge-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\n[pre-commit-badge-url]: https://github.com/pre-commit/pre-commit\n\n[pylint-badge-image]: https://img.shields.io/badge/linting-pylint-yellowgreen\n[pylint-badge-url]: https://github.com/PyCQA/pylint\n\n[read-the-docs-badge-image]: https://readthedocs.org/projects/learn-python-packaging/badge/?version=latest\n[read-the-docs-badge-url]: https://learn-python-packaging.readthedocs.io/en/latest/?badge=latest\n\n[release-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/release.yml/badge.svg\n[release-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/release.yml/\n\n[ruff-badge-image]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n[ruff-badge-url]: https://github.com/astral-sh/ruff\n\n[test-workflow-badge-image]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/test.yml/badge.svg\n[test-workflow-badge-url]: https://github.com/yarnabrina/learn-python-packaging/actions/workflows/test.yml/\n",
"bugtrack_url": null,
"license": "mit",
"summary": "A small example package",
"version": "0.0.5",
"project_urls": {
"Bug Tracker": "https://github.com/yarnabrina/learn-python-packaging/issues",
"Documentation": "https://learn-python-packaging.readthedocs.io",
"Source Code": "https://github.com/yarnabrina/learn-python-packaging"
},
"split_keywords": [
"development",
"packaging",
"sample",
"setuptools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e4bef00c086e8436ecefa5449ab64ca6fb398abf9f9c18e3ed7b9754aac143e",
"md5": "2a17d94cb2a03f0d191c97ba537873f9",
"sha256": "5c1a6ae1c4a81e06015f07999b7cd96ce3c09ab1d29b067e20b7024f651a2460"
},
"downloads": -1,
"filename": "package_name_to_install_with-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a17d94cb2a03f0d191c97ba537873f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 18179,
"upload_time": "2023-12-23T15:16:51",
"upload_time_iso_8601": "2023-12-23T15:16:51.791508Z",
"url": "https://files.pythonhosted.org/packages/1e/4b/ef00c086e8436ecefa5449ab64ca6fb398abf9f9c18e3ed7b9754aac143e/package_name_to_install_with-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3185cf31ead3fed091c8a435a5e6f56d35c3c42e4b920a6d1928f9c046ecb83",
"md5": "1050877f824361b739cda47fd92b7a99",
"sha256": "2fa6573541559bac8dba71b2418734966ed65268feb32588a47558af62de6e9d"
},
"downloads": -1,
"filename": "package-name-to-install-with-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "1050877f824361b739cda47fd92b7a99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 16495,
"upload_time": "2023-12-23T15:16:53",
"upload_time_iso_8601": "2023-12-23T15:16:53.494017Z",
"url": "https://files.pythonhosted.org/packages/a3/18/5cf31ead3fed091c8a435a5e6f56d35c3c42e4b920a6d1928f9c046ecb83/package-name-to-install-with-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-23 15:16:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yarnabrina",
"github_project": "learn-python-packaging",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "package-name-to-install-with"
}
JSON
