gurashish1singh / cookiecutter-python Public

generated from gurashish1singh/initial_setup

Notifications You must be signed in to change notification settings
Fork 0
Star 0

This is a skeleton python cookiecutter template with Ruff as the linter and formatter.

0 stars 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.github/workflows		.github/workflows
hooks		hooks
requirements		requirements
setup		setup
{{ cookiecutter.project_slug }}		{{ cookiecutter.project_slug }}
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
cookiecutter.json		cookiecutter.json
pyproject.toml		pyproject.toml
setup.cfg		setup.cfg
setup.sh		setup.sh

Repository files navigation

Cookiecutter Python Package

A Cookiecutter blank template for a project.

NOTE: Only Python 3.8+ is supported.

Features

Package manager: pip
Formatters and Linters: Ruff
Testing Frameworks (Optional): Pytest, Coverage, and CovDefaults

Usage

bash setup.sh
This template uses post-project generation hooks to:
- Initialize a git repository (with default branch as main), IF the working directory is not already a git repository.
  
  NOTE: You will have to create a repositry on remote if it doesn't already exist before running the cookiecutter command.
- Create a python virtual environment and activate it
- Install ruff
- Include an initial lint github workflow