From b197ae2874490f1d839157c3c060b10c82b112ba Mon Sep 17 00:00:00 2001 From: Gabriel Date: Sun, 29 Mar 2020 11:55:36 -0400 Subject: [PATCH] add lint and test to Pipenv scripts, update docs --- Pipfile | 2 ++ README.md | 18 ++++++------------ 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/Pipfile b/Pipfile index 70c51299..21965c37 100644 --- a/Pipfile +++ b/Pipfile @@ -30,3 +30,5 @@ dev = "uvicorn app.main:APP --reload" start = "uvicorn app.main:APP" fmt = "invoke fmt" sort = "invoke sort" +lint = "invoke lint" +test = "invoke test" diff --git a/README.md b/README.md index cfa41b6c..219d8cc4 100644 --- a/README.md +++ b/README.md @@ -414,32 +414,26 @@ And don't despair if don't get the python setup working on the first try. No one * Visit your app at [http://localhost:5000](http://localhost:5000). ### Running Tests +> [pytest](https://docs.pytest.org/en/latest/) ```bash -pipenv sync --dev -pipenv shell -make test +pipenv run test ``` + ### Linting +> [pylint](https://www.pylint.org/) ```bash -pipenv sync --dev -pipenv shell -make lint +pipenv run lint ``` ### Formatting +> [black](https://black.readthedocs.io/en/stable/) ```bash pipenv run fmt ``` -or -```bash -pipenv shell -make fmt -``` - ### Building