Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.37 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.37 KB

Python Project Template

You can use this repository as a template when creating a new repository on GitHub, to get my preferred setup for a Python project.

Prerequisites

You need brew, direnv, and Python 3 installed before running setup.

Getting started

./scripts/setup.sh

The script will:

  1. Check prerequisites (brew, direnv, python3, git)
  2. Rename the mylib/ package to match your project name
  3. Set the Python version in .python-version
  4. Update the LICENSE with the current year and your name
  5. Create a virtual environment and install dependencies
  6. Install pre-commit hooks

After setup, run direnv allow to activate the environment and ./test to verify everything works.

Then replace this README with content for your new project.

Package naming convention

The convention is for the package directory name to match your project name. If users write import tempo, the directory is tempo/. Avoid generic names like app, lib, core, or utils — they collide with other packages and say nothing about what your code does.

Further reading