wk0/python-project-starter

Basic setup and playground for starting a new project

Python Project Starter

Basic setup and playground for starting a python project

Setup

Dependencies handled with pipenv

If fresh:

pipenv install

Install deps:

pipenv install <package>

Install dev deps:

pipenv install pytest --dev

Activate shell:

pipenv shell

Run tests:

pytest

Tools Used

• pipenv
• python-dotenv
• pytest
• black code formatter
• (jupyter) notebook

Resources

Pipenv scripts

• https://dev.to/elanorigby/i-love-pipenvs-custom-script-shortcuts-156k

Black formatter setup vscode

• https://dev.to/adamlombard/how-to-use-the-black-python-code-formatter-in-vscode-3lo0#:~:text=Black%20is%20%22the%20uncompromising%20Python,save%20a%20file%20in%20VSCode.&text=Open%20your%20VSCode%20settings%2C%20by,%3E%20Preferences%20-%3E%20Settings'.&text=Black%20will%20now%20format%20your%20code%20whenever%20you%20save%20a%20*.

Python-Dotenv

• https://www.askpython.com/python/python-dotenv-module

Project organization loose ideas

• https://gist.github.com/ericmjl/27e50331f24db3e8f957d1fe7bbbe510

Pytest examples

• https://docs.pytest.org/en/6.2.x/example/index.html