Python Package Skeleton
=======================
|PyPI| |GitHub Actions|
.. |PyPI| image:: https://img.shields.io/pypi/v/makenew-pypackage.svg
:target: https://pypi.python.org/pypi/makenew-pypackage
:alt: PyPI
.. |GitHub Actions| image:: https://github.com/makenew/pypackage/actions/workflows/check.yml/badge.svg
:target: https://github.com/makenew/pypackage/actions/workflows/check.yml
:alt: GitHub Actions
Package skeleton for a Python module.
Description
-----------
Bootstrap a new Python_ package in less than a minute.
.. _Python: https://www.python.org/
Features
~~~~~~~~
- Publishing to PyPI_.
- Secure dependency management with Poetry_.
- Linting with Pylint_.
- Uncompromising code formatting with Black_.
- pytest_ helps you write better programs.
- Code coverage reporting with Codecov_.
- Fully automated version management and package publishing with semantic-release__.
- Continuous checks and tests with `GitHub Actions`__.
- `Keep a CHANGELOG`_.
- Consistent coding with EditorConfig_.
- Badges from Shields.io_.
- Start coding instantly with `GitHub Codespaces`_.
.. _Black: https://black.readthedocs.io/en/stable/
.. _Codecov: https://codecov.io/
.. _EditorConfig: https://editorconfig.org/
.. _GitHub Codespaces: https://github.com/features/codespaces
.. _Keep a CHANGELOG: https://keepachangelog.com/
.. _PyPI: https://pypi.python.org/pypi
.. _Pylint: https://www.pylint.org/
.. _Shields.io: https://shields.io/
.. __: https://semantic-release.gitbook.io/semantic-release/
.. __: https://github.com/features/actions
.. _pytest: https://docs.pytest.org/
Bootstrapping a New Project
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Create an empty (**non-initialized**) repository on GitHub.
2. Clone the main branch of this repository with
::
$ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage
$ cd new-pypackage
Optionally, reset to the latest
`release <https://github.com/makenew/pypackage/releases>`__ with
::
$ git reset --hard <version-tag>
3. Run
::
$ ./makenew.sh
This will replace the boilerplate, delete itself,
remove the git remote, remove upstream tags,
and stage changes for commit.
4. Create the required GitHub repository secrets
5. Review, commit, and push the changes to GitHub with
::
$ git diff --cached
$ git commit -m "Replace makenew boilerplate"
$ git remote add origin git@github.com:<user>/<new-pypackage>.git
$ git push -u origin main
6. Ensure the GitHub action passes,
then publish the initial version of the package with
::
$ poetry install
$ poetry version patch
$ make version
Updating
~~~~~~~~
If you want to pull in future updates from this skeleton,
you can fetch and merge in changes from this repository.
Add this as a new remote with
::
$ git remote rename origin upstream
and then configure your ``origin`` branch as normal.
Otherwise, add this as a new remote with
::
$ git remote add upstream git@github.com:makenew/pypackage.git
You can then fetch and merge changes with
::
$ git fetch --no-tags upstream
$ git merge upstream/main
Changelog
^^^^^^^^^
Note that ``CHANGELOG.md`` is just a template for this skeleton. The
actual changes for this project are documented in the commit history and
summarized under
`Releases <https://github.com/makenew/pypackage/releases>`__.
Installation
------------
This package is registered on the `Python Package Index (PyPI)`_
as makenew-pypackage_.
Install it with
::
$ poetry add makenew-pypackage
.. _makenew-pypackage: https://pypi.python.org/pypi/makenew-pypackage
.. _Python Package Index (PyPI): https://pypi.python.org/
Development and Testing
-----------------------
Quickstart
~~~~~~~~~~
::
$ git clone https://github.com/makenew/pypackage.git
$ cd pypackage
$ poetry install
Run each command below in a separate terminal window:
::
$ make watch
Primary development tasks are defined in the `Makefile`.
Source Code
~~~~~~~~~~~
The `source code`__ is hosted on GitHub.
Clone the project with
::
$ git clone https://github.com/makenew/pypackage.git
.. __: https://github.com/makenew/pypackage
Requirements
~~~~~~~~~~~~
You will need `Python 3`_ and Poetry_.
Install the development dependencies with
::
$ poetry install
.. _Poetry: https://poetry.eustace.io/
.. _Python 3: https://www.python.org/
Tests
~~~~~
Lint code with
::
$ make lint
Run tests with
::
$ make test
Run tests on changes with
::
$ make watch
Publishing
~~~~~~~~~~
New versions are created with `poetry version`_.
Automatic
^^^^^^^^^
New versions are released automatically with semantic-release_
as long as commits follow the `Angular Commit Message Conventions`_.
.. _Angular Commit Message Conventions: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
.. _semantic-release: https://semantic-release.gitbook.io/
Manual
^^^^^^
Publish a new version by triggering a `version workflow_dispatch on GitHub Actions`_.
The `version` input will be passed as the first argument to `poetry version`_.
This may be done on the web or using the `GitHub CLI`_ with
::
$ gh workflow run version.yml --raw-field version=<version>
.. _Poetry version: https://python-poetry.org/docs/cli/#version
.. _GitHub CLI: https://cli.github.com/
.. _version workflow_dispatch on GitHub Actions: https://github.com/seamapi/javascript-http/actions?query=workflow%3Aversion
GitHub Actions
--------------
*GitHub Actions should already be configured: this section is for reference only.*
The following repository secrets must be set on GitHub Actions.
- ``PYPI_API_TOKEN``: API token for publishing on PyPI.
These must be set manually.
Secrets for Optional GitHub Actions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The version, format, generate, and semantic-release GitHub actions
require a user with write access to the repository
including access to read and write packages.
Set these additional secrets to enable the action:
- ``GH_TOKEN``: A personal access token for the user.
- ``GIT_USER_NAME``: The name to set for Git commits.
- ``GIT_USER_EMAIL``: The email to set for Git commits.
- ``GPG_PRIVATE_KEY``: The `GPG private key`_.
- ``GPG_PASSPHRASE``: The GPG key passphrase.
.. _GPG private key: https://github.com/marketplace/actions/import-gpg#prerequisites
Contributing
------------
Please submit and comment on bug reports and feature requests.
To submit a patch:
1. Fork it (https://github.com/makenew/pypackage/fork).
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Make changes.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin my-new-feature`).
6. Create a new Pull Request.
License
-------
This Python package is licensed under the MIT license.
Warranty
--------
This software is provided by the copyright holders and contributors "as is" and
any express or implied warranties, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose are
disclaimed. In no event shall the copyright holder or contributors be liable for
any direct, indirect, incidental, special, exemplary, or consequential damages
(including, but not limited to, procurement of substitute goods or services;
loss of use, data, or profits; or business interruption) however caused and on
any theory of liability, whether in contract, strict liability, or tort
(including negligence or otherwise) arising in any way out of the use of this
software, even if advised of the possibility of such damage.
Raw data
{
"_id": null,
"home_page": "https://github.com/makenew/pypackage",
"name": "makenew-pypackage",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.11.0",
"maintainer_email": null,
"keywords": null,
"author": "Evan Sosenko",
"author_email": "razorx@evansosenko.com",
"download_url": "https://files.pythonhosted.org/packages/1d/95/4c9022c31d15ae986609aa106ae660d9d83057b002c7d50ac945c8e848d9/makenew_pypackage-5.1.1.tar.gz",
"platform": null,
"description": "Python Package Skeleton\n=======================\n\n|PyPI| |GitHub Actions|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/makenew-pypackage.svg\n :target: https://pypi.python.org/pypi/makenew-pypackage\n :alt: PyPI\n.. |GitHub Actions| image:: https://github.com/makenew/pypackage/actions/workflows/check.yml/badge.svg\n :target: https://github.com/makenew/pypackage/actions/workflows/check.yml\n :alt: GitHub Actions\n\nPackage skeleton for a Python module.\n\nDescription\n-----------\n\nBootstrap a new Python_ package in less than a minute.\n\n.. _Python: https://www.python.org/\n\nFeatures\n~~~~~~~~\n\n- Publishing to PyPI_.\n- Secure dependency management with Poetry_.\n- Linting with Pylint_.\n- Uncompromising code formatting with Black_.\n- pytest_ helps you write better programs.\n- Code coverage reporting with Codecov_.\n- Fully automated version management and package publishing with semantic-release__.\n- Continuous checks and tests with `GitHub Actions`__.\n- `Keep a CHANGELOG`_.\n- Consistent coding with EditorConfig_.\n- Badges from Shields.io_.\n- Start coding instantly with `GitHub Codespaces`_.\n\n.. _Black: https://black.readthedocs.io/en/stable/\n.. _Codecov: https://codecov.io/\n.. _EditorConfig: https://editorconfig.org/\n.. _GitHub Codespaces: https://github.com/features/codespaces\n.. _Keep a CHANGELOG: https://keepachangelog.com/\n.. _PyPI: https://pypi.python.org/pypi\n.. _Pylint: https://www.pylint.org/\n.. _Shields.io: https://shields.io/\n.. __: https://semantic-release.gitbook.io/semantic-release/\n.. __: https://github.com/features/actions\n.. _pytest: https://docs.pytest.org/\n\nBootstrapping a New Project\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Create an empty (**non-initialized**) repository on GitHub.\n2. Clone the main branch of this repository with\n\n ::\n\n $ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage\n $ cd new-pypackage\n\n Optionally, reset to the latest\n `release <https://github.com/makenew/pypackage/releases>`__ with\n\n ::\n\n $ git reset --hard <version-tag>\n\n3. Run\n\n ::\n\n $ ./makenew.sh\n\n This will replace the boilerplate, delete itself,\n remove the git remote, remove upstream tags,\n and stage changes for commit.\n\n4. Create the required GitHub repository secrets\n5. Review, commit, and push the changes to GitHub with\n\n ::\n\n $ git diff --cached\n $ git commit -m \"Replace makenew boilerplate\"\n $ git remote add origin git@github.com:<user>/<new-pypackage>.git\n $ git push -u origin main\n\n6. Ensure the GitHub action passes,\n then publish the initial version of the package with\n\n ::\n\n $ poetry install\n $ poetry version patch\n $ make version\n\nUpdating\n~~~~~~~~\n\nIf you want to pull in future updates from this skeleton,\nyou can fetch and merge in changes from this repository.\n\nAdd this as a new remote with\n\n::\n\n $ git remote rename origin upstream\n\nand then configure your ``origin`` branch as normal.\n\nOtherwise, add this as a new remote with\n\n::\n\n $ git remote add upstream git@github.com:makenew/pypackage.git\n\nYou can then fetch and merge changes with\n\n::\n\n $ git fetch --no-tags upstream\n $ git merge upstream/main\n\nChangelog\n^^^^^^^^^\n\nNote that ``CHANGELOG.md`` is just a template for this skeleton. The\nactual changes for this project are documented in the commit history and\nsummarized under\n`Releases <https://github.com/makenew/pypackage/releases>`__.\n\nInstallation\n------------\n\nThis package is registered on the `Python Package Index (PyPI)`_\nas makenew-pypackage_.\n\nInstall it with\n\n::\n\n $ poetry add makenew-pypackage\n\n.. _makenew-pypackage: https://pypi.python.org/pypi/makenew-pypackage\n.. _Python Package Index (PyPI): https://pypi.python.org/\n\nDevelopment and Testing\n-----------------------\n\nQuickstart\n~~~~~~~~~~\n\n::\n\n $ git clone https://github.com/makenew/pypackage.git\n $ cd pypackage\n $ poetry install\n\nRun each command below in a separate terminal window:\n\n::\n\n $ make watch\n\nPrimary development tasks are defined in the `Makefile`.\n\nSource Code\n~~~~~~~~~~~\n\nThe `source code`__ is hosted on GitHub.\nClone the project with\n\n::\n\n $ git clone https://github.com/makenew/pypackage.git\n\n.. __: https://github.com/makenew/pypackage\n\nRequirements\n~~~~~~~~~~~~\n\nYou will need `Python 3`_ and Poetry_.\n\nInstall the development dependencies with\n\n::\n\n $ poetry install\n\n.. _Poetry: https://poetry.eustace.io/\n.. _Python 3: https://www.python.org/\n\nTests\n~~~~~\n\nLint code with\n\n::\n\n $ make lint\n\n\nRun tests with\n\n::\n\n $ make test\n\nRun tests on changes with\n\n::\n\n $ make watch\n\nPublishing\n~~~~~~~~~~\n\nNew versions are created with `poetry version`_.\n\nAutomatic\n^^^^^^^^^\n\nNew versions are released automatically with semantic-release_\nas long as commits follow the `Angular Commit Message Conventions`_.\n\n.. _Angular Commit Message Conventions: https://semantic-release.gitbook.io/semantic-release/#commit-message-format\n.. _semantic-release: https://semantic-release.gitbook.io/\n\nManual\n^^^^^^\n\nPublish a new version by triggering a `version workflow_dispatch on GitHub Actions`_.\nThe `version` input will be passed as the first argument to `poetry version`_.\n\nThis may be done on the web or using the `GitHub CLI`_ with\n\n::\n\n $ gh workflow run version.yml --raw-field version=<version>\n\n.. _Poetry version: https://python-poetry.org/docs/cli/#version\n.. _GitHub CLI: https://cli.github.com/\n.. _version workflow_dispatch on GitHub Actions: https://github.com/seamapi/javascript-http/actions?query=workflow%3Aversion\n\nGitHub Actions\n--------------\n\n*GitHub Actions should already be configured: this section is for reference only.*\n\nThe following repository secrets must be set on GitHub Actions.\n\n- ``PYPI_API_TOKEN``: API token for publishing on PyPI.\n\nThese must be set manually.\n\nSecrets for Optional GitHub Actions\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe version, format, generate, and semantic-release GitHub actions\nrequire a user with write access to the repository\nincluding access to read and write packages.\nSet these additional secrets to enable the action:\n\n- ``GH_TOKEN``: A personal access token for the user.\n- ``GIT_USER_NAME``: The name to set for Git commits.\n- ``GIT_USER_EMAIL``: The email to set for Git commits.\n- ``GPG_PRIVATE_KEY``: The `GPG private key`_.\n- ``GPG_PASSPHRASE``: The GPG key passphrase.\n\n.. _GPG private key: https://github.com/marketplace/actions/import-gpg#prerequisites\n\nContributing\n------------\n\nPlease submit and comment on bug reports and feature requests.\n\nTo submit a patch:\n\n1. Fork it (https://github.com/makenew/pypackage/fork).\n2. Create your feature branch (`git checkout -b my-new-feature`).\n3. Make changes.\n4. Commit your changes (`git commit -am 'Add some feature'`).\n5. Push to the branch (`git push origin my-new-feature`).\n6. Create a new Pull Request.\n\nLicense\n-------\n\nThis Python package is licensed under the MIT license.\n\nWarranty\n--------\n\nThis software is provided by the copyright holders and contributors \"as is\" and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. In no event shall the copyright holder or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and on\nany theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package skeleton for a Python module.",
"version": "5.1.1",
"project_urls": {
"Homepage": "https://github.com/makenew/pypackage",
"Repository": "https://github.com/makenew/pypackage"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21a5c5ecdfcf94a347f27468a6950c556a769c3c38f855d28e176e944a5b2ae5",
"md5": "bdcf60619c7f240bff73859b209e3f2c",
"sha256": "ca05de6088a96492fd9fab81e88853a8cab7fbee92f3b78ca78207f9d3ac3dab"
},
"downloads": -1,
"filename": "makenew_pypackage-5.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdcf60619c7f240bff73859b209e3f2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.11.0",
"size": 5466,
"upload_time": "2024-04-18T07:41:32",
"upload_time_iso_8601": "2024-04-18T07:41:32.726255Z",
"url": "https://files.pythonhosted.org/packages/21/a5/c5ecdfcf94a347f27468a6950c556a769c3c38f855d28e176e944a5b2ae5/makenew_pypackage-5.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d954c9022c31d15ae986609aa106ae660d9d83057b002c7d50ac945c8e848d9",
"md5": "7bfad9c9dca034ca7313b850b20951f6",
"sha256": "6cebe587cb091c20479635146d0b0504fc1402d22be2799ac30710e64733f954"
},
"downloads": -1,
"filename": "makenew_pypackage-5.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7bfad9c9dca034ca7313b850b20951f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.11.0",
"size": 4706,
"upload_time": "2024-04-18T07:41:34",
"upload_time_iso_8601": "2024-04-18T07:41:34.163240Z",
"url": "https://files.pythonhosted.org/packages/1d/95/4c9022c31d15ae986609aa106ae660d9d83057b002c7d50ac945c8e848d9/makenew_pypackage-5.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 07:41:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "makenew",
"github_project": "pypackage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "makenew-pypackage"
}
JSON
