Project Structure

Base Directory Structure

.bumpversion.cfg

Config file for bumpversion handled the semantic versioning process. More information at the Development Process description.

.circleci/config.yml

Used CircleCI for handle the Build, Testing, Releasing and Publishing steps.

Status:

ci-scripts

Folder for ci utility scripts like, install selenium.

docs

This project is documentated with sphinx-doc. The generated deployment will be published to ReadTheDocs and nolte.github.io.

Status:

.github

This folder is used form the GitHub Issue Templates.

it-tests

This Folder contains Selenium based pytest integrations tests. Runned after a nolte.github.io/cookiecutter-circleci deployment.

tests

Test for checking the CookieCutter Template generated projects, based on pytest and pytest-cookies.

tox.ini

Using tox for handle the different build and test configs.

Important Tox Environments

Tox Environment	Description
{py27,py36}-test	Start the local builds, used pytest-cookies for testing the cookiecutter template, see Unit tests.
docs	Generate the html sphinx-doc. All required dependencies are listed in requirementsDocs.txt
py36-{github,readthedocs-latest,readthedocs-stable}-integrationtests	Start the Selenium Integration Tests for existing deployments, some type of Smoke Tests, see Integrations tests.

.travis.yml

Build config for the TravisCI Job, used for testing different python versions.

Status: