advanced-python-homework-2023/scada_system/README.md

22 lines
469 B
Markdown
Raw Normal View History

2023-09-25 22:39:20 +03:00
## Installation
1. Install Python
2. Create and activate your virtual environment following the [instructions](https://docs.python.org/3/tutorial/venv.html)
2023-09-27 10:00:37 +03:00
3. Install the `requirements.txt` dependencies following the commands:
```
2023-09-25 22:39:20 +03:00
cd ./scada_system
pip install -r requirements.txt
2023-09-27 10:00:37 +03:00
```
4. Install the package in editable mode:
```
pip install -e .
```
2023-09-25 22:39:20 +03:00
5. To generate documentation in HTML format, you need to run the following commands:
2023-09-27 10:00:37 +03:00
```
2023-09-25 22:39:20 +03:00
cd ./docs
make html
2023-09-27 10:00:37 +03:00
```