advanced-python-homework-2023/1_hw/README.md

33 lines
495 B
Markdown
Raw Permalink Normal View History

2023-09-29 15:16:33 +03:00
# Test package
## Sequence of commands for creating a virtual environment:
2023-09-29 15:18:31 +03:00
```
2023-09-29 15:16:33 +03:00
>> mkdir YOUR_PACKAGE_NAME
>> cd YOUR_PACKAGE_NAME
>> touch __init__.py
>> cd ..
>> touch pyproject.toml
>> open pyproject.toml
...
>> touch LICENSE
>> open LICENSE
...
>> touch README.md
>> open README.md
...
>> python3 -m build
2023-09-29 15:18:31 +03:00
```
2023-09-29 15:16:33 +03:00
## Creating documentation using sphinx:
2023-09-29 15:18:31 +03:00
```
2023-09-29 15:16:33 +03:00
>> mkdir docs
>> cd docs
>> sphinx-quickstart
>> ...
>> touch views.py
>> open views.py
>> ...
>> cd source
>> open index.rst
2023-09-29 15:18:31 +03:00
>> ...
```