Skip to main content

Python project template

Project description

TODO: CI buttons showing the state of the build (pypi, release, Zenodo)

[![Build Status](https://travis-ci.com/kchennen/PythonProject.svg?branch=master)](https://travis-ci.com/kchennen/PythonProject) [![Tests Status](https://github.com/kchennen/PythonProject/workflows/tests/badge.svg)](https://github.com/kchennen/PythonProject/actions) [![Coverage Status](https://coveralls.io/repos/github/kchennen/PythonProject/badge.svg?branch=master)](https://coveralls.io/github/kchennen/PythonProject?branch=master) [![codecov.io](https://codecov.io/github/kchennen/PythonProject/coverage.svg?branch=master)](https://codecov.io/github/kchennen/PythonProject)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/kchennen/PythonProject/blob/master/LICENSE) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkchennen%2FPythonProject.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkchennen%2FPythonProject?ref=badge_shield)

![Python compatibility](https://img.shields.io/pypi/pyversions/PythonProject_KC.svg?label=Python%20Versions) [![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-Green.svg)](https://GitHub.com/kchennen/PythonProject/graphs/commit-activity)

[![GitHub release](https://img.shields.io/github/release/kchennen/StrapDown.js.svg)](https://GitHub.com/kchennen/StrapDown.js/releases/)

[![PyPI status](https://img.shields.io/pypi/status/PythonProject_KC.svg)](https://pypi.python.org/pypi/PythonProject_KC/) [![PyPI version shields.io](https://img.shields.io/pypi/v/PythonProject_KC.svg)](https://pypi.python.org/pypi/PythonProject_KC/) [![PyPI version fury.io](https://badge.fury.io/py/PythonProject_KC.svg)](https://pypi.python.org/pypi/PythonProject_KC/)

# PythonProject

Python project template

See full documentation at https://github.com/kchennen/PythonProject/

## Project Organisation

`text PythonProject ├── .env                       <- Environment variables go here, can be read by `python-dotenv` package ├── .gitignore                 <- Files and directories to be ignored by Git. ├── AUTHORS                    <- List of authors and contributors to this project. ├── CHANGELOG                  <- List of curated chronological notable changes. ├── LICENSE                    <- Project distribution License. ├── README.md                  <- The top-level README for developers using this project. ├── requirements.txt           <- Lsit of the project external dependencies. ├── MANIFEST.in                <- To include extra non-Python files in the source distribution ├── setup.py                   <- Package and distribution management. ├── Makefile                   <- Generic manager to automate Setup, Compilation, Testing and Deployment tasks. │ ├── mkdocs.yml                 <- MkDocs configuration file. ├── docs                       <- Project documentation in Markdown with MkDocs. │ ├── data │   ├── 0_external             <- Data from third party sources. │   ├── 1_raw                  <- The original, immutable data dump. │   ├── 2_interim              <- Intermediate data that has been transformed. │   └── 3_processed            <- The final, canonical data sets for usage. │ ├── pythonproject              <- Source code of interest for this project. │   ├── __init__.py            <- Makes a Python module. │   ├── __main__.py            <- Starting point to run the project in CLI. │   ├── settings.py            <- Script that loads environment variables defined in `.env`. │   └── my_module.py           <- Project module │ ├── tests                      <- A directory containing test code and resources to test none regression behaviour │   └── test_module.py         <- Data from third party sources. ├── tox.ini                    <- Describes the test environments you want your project to run in │ ├── bin │   ├── activate_venv.sh       <- Load Python dev virtual environment │   ├── watchdog_autotest.sh   <- Watchdog script that automatically launch tests on file changes │   └── pythonproject          <- Project runner script │ ├── reports                    <- Generated analysis as HTML, PDF, LaTeX, etc. │   └── figures                <- Generated graphics and figures to be used in reporting │ ├── notebooks                  <- │   └── 00_dashboard.ipynb     <- │ ├── docker                     <- │ ├── github actions             <- │ └── third_parties              <- d `

## Quickstart

### Install - Dev install

python setup.py develop
  • Run project’s installed script

    > pythonproject Hello, World!

## TODO - [ ] Write README - [ ] Quickstart doc (how to quickly install and use your project) - [ ] TravisCI buttons - [ ] Deploy on GitHub - [ ] host doc site

## License ⚖️🔓 [MIT license](LICENSE)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PythonProject_KC, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size PythonProject_KC-0.1.6.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page