Add readme

This commit is contained in:
Colin Goutte 2023-08-23 17:06:10 +02:00
parent 146f9e7e31
commit 52436dc186
4 changed files with 59 additions and 2 deletions

View File

@ -1,3 +1,15 @@
clean:
pipenv --rm
install:
pipenv install
install_dev:
pipenv install --dev
make requirements
run_dev:
pipenv run python dev.py
tdd:
git ls-files | entr pipenv run pytest --lf --nf

View File

@ -18,11 +18,15 @@ clean: _delete_venv _create_venv
install:
$(python) -m pip install -r requirements.txt
install_dev:
$(python) -m pip install -r requirements_dev.txt
test:
already_in_venv=True $(python) -m unittest discover .
run:
run_dev:
$(python) dev.py

View File

@ -9,4 +9,4 @@ name = "pypi"
pytest = "*"
[requires]
python_version = "3.10"
python_version = "3.12"

41
README.rst Normal file
View File

@ -0,0 +1,41 @@
###########
Documentation the movie API project
###########
********
Context
********
We want to code a sample api to so show workskills
========
Stack
========
# Fraweworks
I choose to use `FastAPI <https://fastapi.tiangolo.com/>`
Environement / Install
----------------------
We assume make is installed
if pipenv is installed:
.. code block:: shell
make clean install run_dev
if pipenv is *not* installed
.. code block:: shell
make -f MakefileVenv clean install run_dev
I suggest you have pipenv installed, this projet is writtent under python 3.12 and may work on other versiona
We have a requirement of being virtualenv compatible while i will working with Pipenv.