Skip to content

deontpearson/create-python-repo

Repository files navigation

python pip-tools pre-commit black pytest

{{repo}}

  • charts - Helm charts
  • kubernetes - Adhoc kubernetes YAML files
  • metadata - Files used during the repo creation process.
  • scripts - Scripts for repo admin
  • {{project}} - All the python code
  • tests - All the integration test code

Getting Started

Getting started on development in this repo

Setup your virtual environment

You will have 2 choices here depending on whether you use pyenv-virtualenv or virtualenv

  • Using pyenv-virtualenv:
pyenv virtualenv 3.7.9 $(basename "$PWD")
echo $(basename "$PWD") >| .python-version
  • Using virtualenv:
virtualenv -p python3 venv
source venv/bin/activate

Install dependencies

pip install pip-tools # this repo uses pip-tools
make install # updates syncs the requirements.in with requirements.txt
pre-commit install # installs pre-commit into the virtual env

Note: If you have already set up the environment, and just want to update your dependencies:

make install

Note: If you want to run the pre-commits without committing to a branch:

pre-commit run

Updating requirements

Warning: You should not be editting the .txt files directly

In order to change requirements you must edit the corresponding .in file (e.g: requirements.in) and then run the following command.

make update # generate the .txt files
make deps # ensure the dependencies are installed

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors