https://github.com/justintime50/python-template

A Python project template to save you time and energy.
https://github.com/justintime50/python-template

boilerplate code project pypi python python-template template

Last synced: 3 days ago
JSON representation

A Python project template to save you time and energy.

• Host: GitHub
• URL: https://github.com/justintime50/python-template
• Owner: Justintime50
• License: mit
• Created: 2020-11-19T17:00:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-10T22:22:03.000Z (4 months ago)
• Last Synced: 2025-01-21T19:09:47.026Z (11 days ago)
• Topics: boilerplate, code, project, pypi, python, python-template, template
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 79
• Watchers: 4
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Python Template

A Python project template to save you time and energy.

[![Build Status](https://github.com/Justintime50/python-template/workflows/build/badge.svg)](https://github.com/Justintime50/python-template/actions)

[![Coverage Status](https://coveralls.io/repos/github/Justintime50/python-template/badge.svg?branch=main)](https://coveralls.io/github/Justintime50/python-template?branch=main)

[![Licence](https://img.shields.io/github/license/justintime50/python-template)](LICENSE)





Python projects take a long time to setup with all the various files, the virtual environment, and keeping things uniform across projects. With this Python template, you can quickly setup boilerplate code and miscellaneous items for your Python project saving you time and energy so you can get back to coding.

## Install

Click the [Use this template](https://github.com/Justintime50/python-template/generate) button at the top of this project's GitHub page to get started.

## Usage

### Easy text replacements

1. Replace all instances of `project_name` with the name of your project

    * These are the Python snake_case references (eg: `project_name`)

1. Replace all instances of `PROJECT_NAME_URL` with the name of your project

    * These are the references to your project that will appear in URLs and are typically hyphenated (eg: `project-name`)

1. Replace all instances of `USERNAME` with the name of the author or owner of the project

    * These are references typically found in the URL of your project as it appears on GitHub

### File configuration

1. Configure the `setup.py` file

1. Configure the `justfile` targets

1. Update the name in the `LICENSE` or swap it out entirely

1. Configure the `.github/workflows/build.yml` file

1. Update the `CHANGELOG.md` with your own info

1. Rename other files/folders as needed and configure their content

1. Delete this `README` and rename `README_project.md` to `README.md`

### GitHub configuration

1. Add a `PYPI_API_TOKEN` GitHub secret to your project so that automated releasing can occur from GitHub Actions to PyPI and uncomment the final step on the `release` job in `.github/workflows/release.yml`

## Attribution

* Watch [the video](https://youtu.be/ZMfcl3CnRhA) where I built this template.