https://github.com/syntaxrules/python-starter

A starting spot for python projects. Embracing open source elements.
https://github.com/syntaxrules/python-starter

automation open-source python starter-template

Last synced: about 1 year ago
JSON representation

A starting spot for python projects. Embracing open source elements.

• Host: GitHub
• URL: https://github.com/syntaxrules/python-starter
• Owner: SyntaxRules
• License: mit
• Created: 2017-04-13T21:00:23.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-26T18:17:42.000Z (about 9 years ago)
• Last Synced: 2025-04-11T18:12:45.491Z (about 1 year ago)
• Topics: automation, open-source, python, starter-template
• Language: Python
• Size: 19.5 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# python-starter

A starting spot for python projects. Embracing open source elements.

[![Documentation status](https://readthedocs.org/projects/python-starter/badge/?version=latest)](http://python-starter.readthedocs.io/en/latest/) [![Build Status](https://travis-ci.org/SyntaxRules/python-starter.svg?branch=master)](https://travis-ci.org/SyntaxRules/python-starter) [![codecov](https://codecov.io/gh/SyntaxRules/python-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/SyntaxRules/python-starter)

Documentation: http://python-starter.readthedocs.io/en/latest/

# Project Details

## Structure

This project follows the structure suggested in [Jan-Philip Gehrcke's Blog](https://gehrcke.de/2014/02/distributing-a-python-command-line-application/).

## Versioning

This project uses [Semver](http://semver.org/) as its versioning scheme.

## Tests

Basic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`. The unit tests are in line with the code. You can run all the tests with `python -m pytest .`.

The tests are ran automatically when they are submitted to github via [travici.org](https://travis-ci.org/SyntaxRules/python-starter). Your tests must work here to be considered passing, it doesn't matter if they run on your local machine, if they fail on TravisCI, then they will not be accepted into matser.

Coverage is also determined by TravisCI and reported to [CodeCov](https://codecov.io/gh/SyntaxRules/python-starter).

## Documentation

Documentation is inline (like unit tests) and deployed with [Read the Docs](http://python-starter.readthedocs.io/en/latest/). When editing code, please include documentation for your changes. Add any new files to the `mkdocs.yml` file. The documentation is automatically built and installed.

The documentation is found here: http://python-starter.readthedocs.io/en/latest/

You can test the docs locally by installing [mkdocs](http://www.mkdocs.org/) and running `mkdocs serve` in the root directory of the project source. This will launch a server locally that you can use to view what the docs will look like when deployed. The pages update automatically when changes are made.

You can add a page to the documentation by editing the *mkdocs.yml* file in the source repo. See [Adding Pages](http://www.mkdocs.org/#adding-pages).