chrismccarthydev/git_demo_python

A demo Python project to enable python training for my team

git_demo_python

A demo Python project to enable python training for my team

Developer Notes

Setup Pre-commit

This project has a pre-commit configuration. Before your first commit, you must install the pre-commit config from .pre-commit-config.yaml.

pip install pre-commit
pip install flake8
pre-commit install
pre-commit run --all-files

git_demo_python's Issues

Add pre-commit hook

Background

Add a pre-commit config file that runs various style, lint, and pep8 hooks before commit is approved.

Acceptance Criteria

• A .precommitconfig file exists

Refactor Animal classes to make use of Python data classes

Create Dog class

Create Cat class

Add sphinx docs

Create build pipeline

Background

Add GitHub Actions build pipeline that builds, installs, lints, and runs all tests.

Add additional default attributes and functionality to Animal

Flesh out the initial package structure

Background

The initial animals package structure is required.

Acceptance Criteria

• An animals package.
• An animals.animal module with a base Animal class.
• A working setup.py.