From 450090ceb54267f1eaee8aab71245a586ada9b58 Mon Sep 17 00:00:00 2001
From: Julian Lobbes <julian.lobbes@protonmail.com>
Date: Fri, 2 Sep 2022 21:38:40 +0200
Subject: [PATCH] feat: add .gitignore, requirements and basic README

- added basic instructions on how to make the API key accessible to the
  scripts
---
 .gitignore       |  3 +++
 README.md        | 27 +++++++++++++++++++++++++++
 requirements.txt |  6 ++++++
 3 files changed, 36 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md
 create mode 100644 requirements.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..54fec90
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+.venv
+**/__pycache__
+apikey.yml
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2841606
--- /dev/null
+++ b/README.md
@@ -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>
+
+...
+```
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..6a3bc31
--- /dev/null
+++ b/requirements.txt
@@ -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