https://github.com/flor91/boilerplate_python_project

Template of general tools and setup I like to use on my python projects
https://github.com/flor91/boilerplate_python_project

Last synced: about 1 month ago
JSON representation

Template of general tools and setup I like to use on my python projects

• Host: GitHub
• URL: https://github.com/flor91/boilerplate_python_project
• Owner: Flor91
• License: mit
• Created: 2024-02-08T18:12:13.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-09T13:53:50.000Z (11 months ago)
• Last Synced: 2024-02-09T20:45:04.719Z (11 months ago)
• Language: Makefile
• Size: 143 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Linting](https://github.com/Flor91/boilerplate_python_project/actions/workflows/lint.yml/badge.svg)](https://github.com/Flor91/boilerplate_python_project/actions/workflows/lint.yml)

# Python Project Template

> List of tools and configurations I like to use to start a new Python project

This is a template for a Python project. It is a list of tools and configurations I like to use to start a new Python project. It is a work in progress and I will be adding more tools and configurations along the way.

## Installing / Getting started

To get this project started, follow these steps:

```shell

```

Here you should say what actually happens when you execute the code above.

### Initial Configuration

Some projects require initial configuration (e.g. access tokens or keys, `npm i`).

This is the section where you would document those requirements.

## Features

What's all the bells and whistles this project can perform?

* What's the main functionality

* You can also do another thing

* If you get really randy, you can even do this

Your job is to

* tell them what it is (with context)

* show them what it looks like in action

* show them how they use it

* tell them any other relevant details

## Contributing

If you'd like to contribute, please fork the repository and use a feature

branch. Pull requests are warmly welcome.

## Tools

This project uses the following tools:

* [Python](https://www.python.org/)

* [Git](https://git-scm.com/)

* [Poetry](https://python-poetry.org/)

* [Black](https://black.readthedocs.io/en/stable/)

* [Flake8](https://flake8.pycqa.org/en/latest/)

* [Pytest](https://docs.pytest.org/en/stable/)

* [Sphinx](https://www.sphinx-doc.org/en/master/)

* [Make](https://www.gnu.org/software/make/)

* [FastAPI](https://fastapi.tiangolo.com/)

## Licensing

"The code in this project is licensed under MIT license."