feat: add .gitignore, requirements and basic README
- added basic instructions on how to make the API key accessible to the scripts
This commit is contained in:
commit
450090ceb5
3 changed files with 36 additions and 0 deletions
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
.venv
|
||||||
|
**/__pycache__
|
||||||
|
apikey.yml
|
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# Ionos DNS updates
|
||||||
|
|
||||||
|
A set of scripts used to make dynamic DNS updates to the Ionos API.
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
Python libraries:
|
||||||
|
- [requests](https://pypi.org/project/requests/)
|
||||||
|
- [pyyaml](https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
### Initial setup
|
||||||
|
|
||||||
|
Install the [dependencies](#dependencies), preferrably using your system's package manager.
|
||||||
|
|
||||||
|
Next, you will need your Ionos API keypair.
|
||||||
|
Clone the repo and create a file called `apikey.yml` at the project root.
|
||||||
|
Inside the file, paste your Ionos API-keypair in the following format:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
|
||||||
|
apikey:
|
||||||
|
prefix: <your api key prefix>
|
||||||
|
secret: <your api key secret>
|
||||||
|
|
||||||
|
...
|
||||||
|
```
|
6
requirements.txt
Normal file
6
requirements.txt
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
certifi==2022.6.15
|
||||||
|
charset-normalizer==2.1.1
|
||||||
|
idna==3.3
|
||||||
|
PyYAML==6.0
|
||||||
|
requests==2.28.1
|
||||||
|
urllib3==1.26.12
|
Loading…
Add table
Reference in a new issue