Piotr Maślanka
py-scaffold

Repository



your_project


This is a generic scaffold for Python projects that use:


GitLab CI for builds/tests/deploys

coverage.py for test coverage

nose for unit tests

Vagrant for environment

setuptools for packaging

git for version control


How to use

git clone http://git.dms-serwis.com.pl/henrietta/py-scaffold.git
delete .git directory
Rename your_project_source to match your project
adjust setup.py, and optionally setup.cfg

adjust .coveragerc

adjust license

adjust or delete contribution guide

adjust or delete change log

adjust Vagrantfile, or remove it
adjust MANIFEST.in if you have data files
adjust docs

adjust gitlab-ci.yml, especially if your tests require a
Vagrant environment
Set up a repository on GitLab
Ensure you have master permission on this repository
Set ^TOTAL\s+\d+\s+\d+\s+\d+\s+\d+\s+(\d+)%$ in
Settings>CI/CD Pipelines>Test coverage parsing for GitLab to display
test coverage data
git init
Add suitable remotes, commit the data, push to repo
Done!