Merge pull request #4 from SmileyJoe/add-docker-cron

Adding docker with daily cron

Author: SmileyJoe

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.10
+
+RUN apt-get update && apt-get -y install cron vim
+
+WORKDIR /github/app
+COPY ./app /github/app
+COPY ./repos /github/repos
+
+RUN pip install -r requirements.txt
+COPY crontab /etc/cron.d/crontab
+
+RUN chmod 0644 /etc/cron.d/crontab
+RUN /usr/bin/crontab /etc/cron.d/crontab
+
+# run crond as main process of container
+CMD ["cron", "-f"]

README.md

@@ -6,12 +6,21 @@ This is meant as a backup, the repos it clones should not be updated as there is
 
 ## Setup
 
-- Duplicate `example_config.yaml` and rename it to `config.yaml`
+- Copy `example_config.yaml` into `app/` and rename it to `config.yaml`
 - Update `config.yaml` with your keys/settings
-- Install the requirements with `pip install -r requirements.txt`
 - See [here](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) for generating a github token
 - For the pushover api token, a new app will need to be registered [here](https://pushover.net/apps/build)
 
+## Docker
+
+- Update `Dockerfile` and `docker-compose.yml` to reference the local directory the repos will be cloned to
+- Run the container with `docker-compose up -d`
+
+## Without docker
+
+- Install the requirements with `pip install -r requirements.txt`
+- Run with `python app/main.py`
+
 ## Translations
 
 - Copy a language file, rename the 2 letter code and translate it, the file can them be specified in `config.yaml`

config.py app/config.pyconfig.py renamed to app/config.py

@@ -27,7 +27,12 @@
 
         # if the path is not set, we need to clone the repo
         if not os.path.isdir(repo_dir):
-            Repo.clone_from(repo.ssh_url, repo_dir)
+            # clone using the token, this means ssh doesn't need to be setup
+            repo_url = "https://{username}:{password}@github.com/{repo_name}.git".format(
+                username=config.github.username,
+                password=config.github.token,
+                repo_name=repo.full_name)
+            Repo.clone_from(repo_url, repo_dir)
             log.cloned(repo.name)
         # else we need to pull the new contents
         else:

db.py app/db.pydb.py renamed to app/db.py

@@ -0,0 +1,2 @@
+#run python script every day at midnight
+0 0 * * * /usr/local/bin/python /github/app/main.py > /proc/1/fd/1 2>/proc/1/fd/2

language_en.yaml app/language_en.yamllanguage_en.yaml renamed to app/language_en.yaml

@@ -0,0 +1,7 @@
+version: '1'
+services:
+    github:
+        build: .
+        volumes:
+            - ./app:/github/app
+            - ./repos:/github/repos