/boilerplate_python_project

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

Primary LanguageMakefileMIT LicenseMIT

drawing

Linting

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:

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:

Licensing

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