This repository contains standard templates for configuration files and tools for setting up general purpose Python projects that follow best practices.
This is a standard template for the global Hatch settings and will alter how Hatch projects are created across your machine.
When setting up Hatch on your local machine, copy and paste the components of the hatch toml to your config.toml file. Config file location is detailed here: https://hatch.pypa.io/latest/config/hatch/#environments
Make sure to replace:
- USERNAME with your user name on your machine
- NAME with your name (this will appear in the project toml files under 'author')
- EMAIL with your email (this will appear in the project toml files under 'author')
This is an 'all-in-one' script for setting up a new project. Run this script from the parent directory that you want to project to be stored in. Its good practice to keep all your local repos in a central directory e.g. "~/Documents/Zifo_Python_Projects". Run the command like so:
sh project_setup.sh PROJECTWhere PROJECT is the name of your project. A new folder will be created with that name and setup with a standard structure.
If you run this bash script you can ignore the other instructions below.
Standard template for a Python project. After creating your project with hatch new, but before creating your virtual environment, copy this file into your project directory with:
curl https://raw.githubusercontent.com/zifods/config_templates/main/pyproject.toml > pyproject.tomlThis will replace the existing toml file. After replacing this file, check for any additional changes you might need to make to the setup for your specific project, then run the following to create your virtual environment:
hatch env createIf you have copied the pyproject.toml template from this repository the pre-commit template will be downloaded automatically when creating a new environment
This is a standard pre-commit template. Use this to setup your pre-commit installation and ensure that standards are met prior to commiting code to your branch.
After creating your project with hatch new, but before creating your virtual environment, copy this file into your project directory with:
curl https://raw.githubusercontent.com/zifods/config_templates/main/.pre-commit-config.yaml --output .pre-commit-config.yaml