Skip to content

Readme

Contributors Forks Stargazers Issues MIT License


Python Project Template

Python template with some awesome tools to quickstart any Python project
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Python template with some awesome tools to quickstart any Python project

(back to top)

Getting Started

To run this project locally, you will need to install the prerequisites and follow the installation section.

Prerequisites

This Project depends on the following projects. * Poetry sh pip install --user --upgrade poetry

  • Poe the Poet sh pip install --user --upgrade poethepoet

Installation

  1. Clone the repo sh git clone https://github.com/nullhack/python-project-template cd python-project-template
  2. Install Poe the Poet and Poetry sh pip install --user --upgrade poethepoet poetry
  3. Install requirements for development sh poe install-dev
  4. Run tests sh poe test

(back to top)

Usage

Some useful examples of how this project can be used:

  • Install requirements sh poe install-dev

  • Run tests sh poe test

  • Run the project sh poe run

  • Generate API documentation sh poe doc

  • Build a docker image for tests sh poe docker-build --target test --build-tag 3.10-alpine docker run -ti --rm python_package_template:test-3.10-alpine

  • Build a docker image to run the root files only without running any test sh poe docker-build --target prod --build-tag 3.10-alpine --no-test docker run -ti --rm python_package_template:prod-3.10-alpine

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [x] Add tests
  • [x] Add code coverage
  • [x] Improve documentation
  • [ ] Include more tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Eric Lopes - @nullhack - nullhack@users.noreply.github.com

Project Link: https://github.com/nullhack/python-project-template/

(back to top)

Acknowledgments

This project was created using cookiecutter and NullHack's python-project-template:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)