diff --git a/README.md b/README.md index e41880a..d1789a2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ **A script set for web services management.** +## Dependencies + +- [astral uv: Python package manager](https://docs.astral.sh/uv/) + ## Usage - First clone the repository @@ -11,14 +15,24 @@ cd webscripts ``` -- Launch the manager with `main.py` +- Initialize Python virtual environment and install dependencies ```bash - ./main.py + uv venv --python=3.12 + uv pip install -r requirement.txt + ``` + +- Launch the manager with `main.py` + + >[!IMPORTANT] + >If you have some reasons have to waste using uv, you should create virtual environment and install the dependencies manually, otherwise, it is recommended to use uv to manage those because of its convenience. + + ```bash + uv run main.py ``` Add `-h` as parameter to find usage: ```bash - ./main.py -h + uv run main.py -h usage: main.py [-h] {register,list,operate} ... =====> Web Services Manager <===== diff --git a/data/services.json b/data/services.json index f663bb8..0637a08 100644 --- a/data/services.json +++ b/data/services.json @@ -1,12 +1 @@ -[ - { - "tag": "sys", - "name": "nginx", - "path": null - }, - { - "tag": "docker", - "name": "homepage", - "path": "/home/virtualguard/projects/webservices/homepage" - } -] \ No newline at end of file +[] \ No newline at end of file