Package: makenew-pypackage
Package skeleton for a Python module.DescriptionBootstrap a newPythonpackage in less than a minute.FeaturesPublishing toPyPI.Secure dependency management withPoetry.Linting withPylint.Uncompromising code formatting withBlack.pytesthelps you write better programs.Code coverage reporting withCodecov.Continuous testing and deployment withGitHub Actions.Keep a CHANGELOG.Consistent coding withEditorConfig.Badges fromShields.io.Bootstrapping a New ProjectCreate an empty (non-initialized) repository on GitHub.Clone the main branch of this repository with$ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage
$ cd new-pypackageOptionally, reset to the latestreleasewith$ git reset --hard <version-tag>Run$ ./makenew.shThis will replace the boilerplate, delete itself,
remove the git remote, remove upstream tags,
and stage changes for commit.Create the required GitHub repository secretsReview, 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 mainEnsure the GitHub action passes,
then publish the initial version of the package with$ poetry install
$ poetry version patch
$ make versionUpdatingIf 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 upstreamand then configure youroriginbranch as normal.Otherwise, add this as a new remote with$ git remote add upstream git@github.com:makenew/pypackage.gitYou can then fetch and merge changes with$ git fetch --no-tags upstream
$ git merge upstream/mainChangelogNote thatCHANGELOG.mdis just a template for this skeleton. The
actual changes for this project are documented in the commit history and
summarized underReleases.InstallationThis package is registered on thePython Package Index (PyPI)asmakenew-pypackage.Install it with$ poetry add makenew-pypackageDevelopment and TestingQuickstart$ git clone https://github.com/makenew/pypackage.git
$ cd pypackage
$ poetry installRun each command below in a separate terminal window:$ make watchPrimary development tasks are defined in theMakefile.Source CodeThesource codeis hosted on GitHub.
Clone the project with$ git clone https://github.com/makenew/pypackage.gitRequirementsYou will needPython 3andPoetry.Install the development dependencies with$ poetry installTestsLint code with$ make lintRun tests with$ make testRun tests on changes with$ make watchPublishingUse thepoetry versioncommand to release a new version.
Then runmake versionto commit and push a new git tag
which will trigger a GitHub action.Publishing may be triggered using aworkflow_dispatch on GitHub Actions.GitHub ActionsGitHub 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 ActionsThe version and format 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: TheGPG private key.GPG_PASSPHRASE: The GPG key passphrase.ContributingPlease submit and comment on bug reports and feature requests.To submit a patch:Fork it (https://github.com/makenew/pypackage/fork).Create your feature branch (git checkout -b my-new-feature).Make changes.Commit your changes (git commit -am ‘Add some feature’).Push to the branch (git push origin my-new-feature).Create a new Pull Request.LicenseThis Python package is licensed under the MIT license.WarrantyThis 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.