Skip to content
Snippets Groups Projects
Piotr Maslanka's avatar
Piotr Maślanka authored
a972fe35

your_project

build status coverage report

This is a generic scaffold for Python projects that use:

  • this GitLab CI for builds/tests/deploys
  • coverage.py for test coverage
  • nose for unit tests
  • Vagrant for environment
  • setuptools for packaging

How to use

  1. git clone http://git.dms-serwis.com.pl/henrietta/py-scaffold.git
  2. Delete .git directory
  3. Adjust this code to your project 3.1. Rename your_project_source to match your project 3.2. adjust setup.py 3.3. adjust .coveragerc 3.4. adjust license 3.5. adjust Vagrantfile, or remove it 3.6. adjust MANIFEST.in if you have data files 3.7. adjust docs 3.8. adjust gitlab-ci.yml, especially if your tests require a Vagrant environment
  4. Set up a repository on GitLab
  5. Ensure you have master permission on this repository
  6. 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
  7. git init
  8. Add suitable remotes, commit the data, push to repo
  9. Done!