Skip to content

A python boilerplate including pytest, code coverage, documentation, and some scripts utils

License

Notifications You must be signed in to change notification settings

rsaz/python-project-template

Repository files navigation

Project Title

This is a project template for a python package.

Description

This is a project template for a python package. Its is meant to be a starting point for your python package project. It provides a project structure that is easy to start with and can grow to support a wide variety of features.

Getting Started

Dependencies

  • Python 3.8+
  • pipenv
  • pytest
  • pytest-cov
  • pylint

Installing

  • Clone the repository

Executing the program

  • How to run the program
python ./src/main.py
  • How to run the tests
# Go inside of the tests folder in the root directory
pytest
  • How to run test with coverage
pytest --cov .

Help

Contact me at email

As an example, commands to run in order to get support and inform about an issue

Authors

  • [@your name](your github profile)

Version History

  • 0.1
    • Initial Release

License

This project is licensed under the [your license] License - See the LICENSE.md file for details

About

A python boilerplate including pytest, code coverage, documentation, and some scripts utils

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages