Skip to content

Commit

Permalink
Updated .gitignore and readme (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexBonadei authored Feb 9, 2024
1 parent 6475c50 commit ea3f3f8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
__pycache__
**.pytest_cache
.venv
.coverage
.coverage
env
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ To develop the service locally you need:
A virtual environment is a Python tool for dependency management and project
isolation. For further info about the creation and management of a virtual environment,
please check the [Python official documentation](https://docs.python.org/3/library/venv.html).
To create your virtual environment run the following command:

```shell
python -m venv /path/to/new/virtual/environment
```

To activate your virtual envirorment run the following command on
your terminal:

Expand All @@ -31,6 +37,8 @@ command:
deactivate
```

Remember to put the path to the virtual environment in the `.gitignore` file.

During development, you will probably have to perform the same operations many
times: start the application locally, check the code quality, run tests and compute coverage. Therefore,
to avoid to remember each time the syntax of the commands to be executed, the
Expand Down

0 comments on commit ea3f3f8

Please sign in to comment.