Skip to content

README.md

Latest commit

 

History

History
30 lines (22 loc) · 1.89 KB

README.md

File metadata and controls

30 lines (22 loc) · 1.89 KB

Python-template

Build Status Codacy Badge Codacy Badge

This repository is a generic template for Python projects.

Setting up CI

This project template uses Travis as a CI pipeline and Codacy for quality and coverage metrics. Travis also builds a Docker image and pushes it to Docker Hub so Docker Hub credentials are needed.

To get the newly initialized project configured, add it to Travis and Codacy. After that, go to the project view in Codacy and choose Settings > Integrations > Add integration > Project API and click the Settings button of the newly created Project API. Travis needs the Project API Token to upload coverage data to Codacy.

Encrypt the needed environment variables to .travis.yml with the following commands:

travis encrypt CODACY_PROJECT_TOKEN=[] --add
travis encrypt DOCKER_USERNAME=[] --add
travis encrypt DOCKER_PASSWORD=[] --add

If you want to add Slack notifications, use:

travis encrypt [SLACK_TOKEN] --add notifications.slack

You should also change the badges at the top of this README to the ones that are generated for your project. Travis badge can be found next to the project name and Codacy badges are in the project settings.