About

This repo is basically my template for new repos/projects

CI Template:

By default this template will assume that the GHA Service and Circle-CI Service are used for CI/CD

Status

master:

Stable:

How do I use this to create a new project repo?

(assuming new project is already forked on github to MY-NEW-REPO)

# cd /MY-AWSOME-DEV-PATH
git clone https://github.com/reactive-firewall/MY-NEW-REPO.git MY-NEW-REPO
# cd ./MY-NEW-REPO

Dev Testing Template:

In a rush? Then use this:

make clean ; # cleans up from any previous tests hopefully
make test ; # runs the tests
make clean ; # cleans up for next test

Use PEP8 to check code style? Great! Try this:

make clean ; # cleans up from any previous tests hopefully
make test-style ; # runs the tests
make clean ; # cleans up for next test

Want more tests? Cool! Try tox:

make clean ; # cleans up from any previous tests hopefully
make test-tox ; # runs the tox tests
make clean ; # cleans up for next test

Next steps:

Like automation? Then integrate away, this template can take it! (hint: @coderabbitai, @travis-ci, @houndci-bot, @pyup-bot, @circleci, @codecov-io, @lemurheavy, @coverallsapp, @codeclimate)

Not in a rush? Then be sure to edit the badges in the README. (hint: sed -e 's/python-repo/MY-NEW-REPO' ./README.md)