Remove poetry #93019
25
DEVELOP.md
25
DEVELOP.md
@ -19,15 +19,26 @@ this to downstream instead?".
|
|||||||
# Development environment
|
# Development environment
|
||||||
|
|
||||||
To set up your development environment make sure you have valid version of
|
To set up your development environment make sure you have valid version of
|
||||||
Python (check `pyproject.toml`) with [Poetry](https://python-poetry.org/)
|
Python (check `pyproject.toml`) and a `virtualenv`.
|
||||||
installed on your `PATH` and then do the following in the root of the
|
|
||||||
repository:
|
Use your favourite way of setting up a `virtualenv`, e.g.:
|
||||||
```
|
```
|
||||||
poetry install # Install dependencies.
|
mkvirtualenv -a `pwd` looper -p /usr/bin/python3.10
|
||||||
|
```
|
||||||
|
|
||||||
|
Or simply use `venv` module directly:
|
||||||
|
```
|
||||||
|
python3.10 -m venv .venv ; source .venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
After `virtualenv` has been created and activated, continue with the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install -r requirements_dev.txt # Install dependencies.
|
||||||
cp looper_example_project/settings.example.py looper_example_project/settings.py # Adjust settings.py as needed.
|
cp looper_example_project/settings.example.py looper_example_project/settings.py # Adjust settings.py as needed.
|
||||||
# Make sure you have your database setup according to your settings.py
|
# Make sure you have your database setup according to your settings.py
|
||||||
./manage.sh migrate # Update the schema.
|
./manage.py migrate # Create database tables and run migrations.
|
||||||
./test.sh # Make sure the tests run.
|
./manage.py test # Make sure the tests run.
|
||||||
```
|
```
|
||||||
|
|
||||||
# Testing
|
# Testing
|
||||||
@ -44,4 +55,4 @@ are checked as part of `./test.sh`.
|
|||||||
|
|
||||||
We use [Black](https://black.readthedocs.io/en/stable/) to format code. Proper
|
We use [Black](https://black.readthedocs.io/en/stable/) to format code. Proper
|
||||||
formatting is checked as part of the tests in `/test.sh`. To reformat the whole
|
formatting is checked as part of the tests in `/test.sh`. To reformat the whole
|
||||||
codebase run `poetry run black .`
|
codebase run `black .`
|
||||||
|
Loading…
Reference in New Issue
Block a user