add README.md with 'Getting started' section
add .env.example add requierements.txt
This commit is contained in:
parent
9b04cde31b
commit
c1f8167f06
1
.env.example
Normal file
1
.env.example
Normal file
@ -0,0 +1 @@
|
|||||||
|
HETZNER_API_TOKEN=
|
11
README.md
Normal file
11
README.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
## Getting started
|
||||||
|
|
||||||
|
0. Install Python.
|
||||||
|
1. Create virtual environment: `python3 -m venv .venv`.
|
||||||
|
2. To activate the virtual environment, enter: `source .venv/bin/activate`.
|
||||||
|
3. Install a list of requirements specified in [requirements.txt](./requirements.txt):
|
||||||
|
`python -m pip install -r requirements.txt`.
|
||||||
|
4. Create a .env file `cp .env.example .env` and provide values of envirnoment variables.
|
||||||
|
5. Run the script: `python main.py`.
|
||||||
|
|
||||||
|
> When you're finished with your virtual environment, enter the following command to deactivate it: `deactivate`.
|
2
requirements.txt
Normal file
2
requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
python-dotenv
|
||||||
|
hcloud
|
Loading…
Reference in New Issue
Block a user