Giter Club home page Giter Club logo

python_project_template's Introduction

Build Status Coverage Status Docker Automated build

TL;DR

  1. Clone
  2. make
  3. ./python_project_template.py wizard
  4. Copy build/ to your project workspace
  5. Happy Coding

Overview

Create python projects based on the Python Structure Guide. The associated GitHub with a simple module is located here. In the basic sense this generates a module for you based on your requirements.

The project can be generated via 2 different methods, one is via a wizard and the other via command line arguments. For either one the following components will be setup:

  • Sphinx with a configuration file setup for you based on the project settings
  • pytest in the tests directory with a couple of files to get you started.

python_project_template's People

Contributors

darless avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

python_project_template's Issues

Generate a travis file .travis.yml

This would be necessary so that if the resulting repo is connected to Travis CI then it will be tested. We would want it to run make test for us. We would also want it to run coveralls so that if coveralls is associated with Travis CI then the code coverage will be updated on that site.

Update the README.md to have badges

Badges allow you to see the state of your project at any time without having to manually go to different locations.

Let's say you have the following setup:

  • GitHub with your repository
  • Travis CI linked to GitHub
  • Coveralls linked to GitHub and Travis CI
  • DockerHub linked to GitHub

The following would allow you to:

  • On a push to github
  • travis CI pulls down the changes and tests it
  • It then notifies Coveralls with the coverage results
  • Docker Hub also updates the public image that can be pulled down.

The badges would then show the following:

  • Build Status (From Travis CI)
  • Coverage Status (From Coverall)
  • Docker Automated Build (From Docker Hub) - Whether its automated/manual/..

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.