Merge pull request #880 from elebumm/develop

2.3

.config.template.toml

@@ -0,0 +1,45 @@
+[reddit.creds]
+client_id = { optional = false, nmin = 12, nmax = 30, explanation = "the ID of your Reddit app of SCRIPT type", example = "fFAGRNJru1FTz70BzhT3Zg", regex = "^[-a-zA-Z0-9._~+/]+=*$", input_error = "The client ID can only contain printable characters.", oob_error = "The ID should be over 12 and under 30 characters, double check your input." }
+client_secret = { optional = false, nmin = 20, nmax = 40, explanation = "the SECRET of your Reddit app of SCRIPT type", example = "fFAGRNJru1FTz70BzhT3Zg", regex = "^[-a-zA-Z0-9._~+/]+=*$", input_error = "The client ID can only contain printable characters.", oob_error = "The secret should be over 20 and under 40 characters, double check your input." }
+username = { optional = false, nmin = 3, nmax = 20, explanation = "the username of your reddit account", example = "JasonLovesDoggo", regex = "^[-_0-9a-zA-Z]+$", oob_error = "A username HAS to be between 3 and 20 characters" }
+password = { optional = false, nmin = 8, explanation = "the password of your reddit account", example = "fFAGRNJru1FTz70BzhT3Zg", oob_error = "Password too short" }
+2fa = { optional = true, type = "bool", options = [true,
+    false,
+], default = false, explanation = "Whether you have Reddit 2FA enabled, Valid options are True and False", example = true }
+
+
+[reddit.thread]
+random = { optional = true, options = [true,
+    false,
+], default = false, type = "bool", explanation = "If set to no, it will ask you a thread link to extract the thread, if yes it will randomize it. Default: 'False'", example = "True" }
+subreddit = { optional = false, regex = "[_0-9a-zA-Z]+$", nmin = 3, explanation = "what subreddit to pull posts from, the name of the sub, not the URL", example = "AskReddit", oob_error = "A subreddit name HAS to be between 3 and 20 characters" }
+post_id = { optional = true, default = "", regex = "^((?!://|://)[+a-zA-Z])*$", explanation = "Used if you want to use a specific post.", example = "urdtfx" }
+max_comment_length = { default = 500, optional = false, nmin = 10, nmax = 10000, type = "int", explanation = "max number of characters a comment can have. default is 500", example = 500, oob_error = "the max comment length should be between 10 and 10000" }
+post_lang = { default = "", optional = true, explanation = "The language you would like to translate to.", example = "es-cr" }
+min_comments = { default = 20, optional = false, nmin = 15, type = "int", explanation = "The minimum number of comments a post should have to be included. default is 20", example = 29, oob_error = "the minimum number of comments should be between 15 and 999999" }
+[settings]
+allow_nsfw = { optional = false, type = "bool", default = false, example = false, options = [true,
+    false,
+], explanation = "Whether to allow NSFW content, True or False" }
+theme = { optional = false, default = "dark", example = "light", options = ["dark",
+    "light",
+], explanation = "sets the Reddit theme, either LIGHT or DARK" }
+times_to_run = { optional = false, default = 1, example = 2, explanation = "used if you want to run multiple times. set to an int e.g. 4 or 29 or 1", type = "int", nmin = 1, oob_error = "It's very hard to run something less than once." }
+opacity = { optional = false, default = 0.9, example = 0.8, explanation = "Sets the opacity of the comments when overlayed over the background", type = "float", nmin = 0, nmax = 1, oob_error = "The opacity HAS to be between 0 and 1", input_error = "The opacity HAS to be a decimal number between 0 and 1" }
+storymode = { optional = true, type = "bool", default = false, example = false, options = [true,
+    false,
+], explanation = "not yet implemented" }
+
+[settings.background]
+background_choice = { optional = true, default = "minecraft", example = "minecraft", options = ["minecraft", "gta", "rocket-league", "motor-gta", ""], explanation = "Sets the background for the video" }
+#background_audio = { optional = true, type = "bool", default = false, example = false, options = [true,
+#    false,
+#], explaination="Sets a audio to play in the background (put a background.mp3 file in the assets/backgrounds directory for it to be used.)" }
+#background_audio_volume = { optional = true, type = "float", default = 0.3, example = 0.1, explanation="Sets the volume of the background audio. only used if the background_audio is also set to true" }
+
+
+[settings.tts]
+choice = { optional = false, default = "", options = ["streamlabspolly", "tiktok", "googletranslate", "awspolly", ], example = "streamlabspolly", explanation = "The backend used for TTS generation. This can be left blank and you will be prompted to choose at runtime." }
+aws_polly_voice = { optional = false, default = "Matthew", example = "Matthew", explanation = "The voice used for AWS Polly" }
+streamlabs_polly_voice = { optional = false, default = "Matthew", example = "Matthew", explanation = "The voice used for Streamlabs Polly" }
+tiktok_voice = { optional = false, default = "en_us_006", example = "en_us_006", explanation = "The voice used for TikTok TTS" }

.github/workflows/autoblack.yml

@@ -0,0 +1,32 @@
+# GitHub Action that uses Black to reformat the Python code in an incoming pull request.
+# If all Python code in the pull request is compliant with Black then this Action does nothing.
+# Othewrwise, Black is run and its changes are committed back to the incoming pull request.
+# https://github.com/cclauss/autoblack
+
+name: autoblack
+on:
+  push:
+    branches: ["master"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Install Black
+        run: pip install black
+      - name: Run black --check .
+        run: black --check .
+      - name: If needed, commit black changes to the pull request
+        if: failure()
+        run: |
+          black . --line-length 101
+          git config --global user.name 'autoblack'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY
+          git checkout $GITHUB_HEAD_REF
+          git commit -am "fixup: Format Python code with Black"
+          git push

.github/workflows/codeql-analysis.yml

@@ -14,10 +14,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "master", "develop" ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "master" ]
+    branches: [ "master", "develop" ]
   schedule:
     - cron: '16 14 * * 3'
 

.github/workflows/lint.yml

@@ -0,0 +1,12 @@
+name: Lint
+
+on: [pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: psf/black@stable
+        with:
+          options: "--line-length 101"

.github/workflows/stale.yml

@@ -5,36 +5,46 @@ on:
     - cron: '0 0 * * *'
 
 jobs:
+
   stale:
     runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
     steps:
-      - uses: actions/stale@main
+      - uses: actions/stale@v4
         id: stale-issue
         name: stale-issue
         with:
+          # general settings
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
           stale-issue-message: 'This issue is stale because it has been open 7 days with no activity. Remove stale label or comment, or this will be closed in 10 days.'
           close-issue-message: 'Issue closed due to being stale. Please reopen if issue persists in latest version.'
-          days-before-stale: 7
-          days-before-close: 10
+          days-before-stale: 6
+          days-before-close: 12
           stale-issue-label: 'stale'
           close-issue-label: 'outdated'
           exempt-issue-labels: 'enhancement,keep,blocked'
           exempt-all-issue-milestones: true
           operations-per-run: 300
           remove-stale-when-updated: true
-
-      - uses: actions/stale@main
+          ascending: true
+          #debug-only: true
+
+      - uses: actions/stale@v4
         id: stale-pr
         name: stale-pr
         with:
+          # general settings
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
           stale-pr-message: 'This pull request is stale as it has been open for 7 days with no activity. Remove stale label or comment, or this will be closed in 10 days.'
           close-pr-message: 'Pull request closed due to being stale.'
-          days-before-stale: 7
-          days-before-close: 10
+          days-before-stale: 10
+          days-before-close: 20
           close-pr-label: 'outdated'
           stale-pr-label: 'stale'
           exempt-pr-labels: 'keep,blocked,before next release,after next release'
           exempt-all-pr-milestones: true
           operations-per-run: 300
           remove-stale-when-updated: true
-
+          #debug-only: true

.gitignore

@@ -241,3 +241,5 @@ reddit-bot-351418-5560ebc49cac.json
 *.pyc
 video_creation/data/videos.json
 video_creation/data/envvars.txt
+
+config.toml

CONTRIBUTING.md

@@ -111,7 +111,16 @@ When making your PR, follow these guidelines:
 
 - Your branch has a base of _develop_, **not** _master_
 - You are merging your branch into the _develop_ branch
-- You link any issues that are resolved or fixed by your changes. (this is done by typing "Fixes #\<issue number\>") in your pull request.
+- You link any issues that are resolved or fixed by your changes. (this is done by typing "Fixes #\<issue number\>") in your pull request
+- Where possible, you have used `git pull --rebase`, to avoid creating unnecessary merge commits
+- You have meaningful commits, and if possible, follow the commit style guide of `type: explanation`
+- Here are the commit types: 
+ - **feat** - a new feature
+ - **fix** - a bug fix
+ - **docs** - a change to documentation / commenting
+ - **style** - formatting changes - does not impact code
+ - **refactor** - refactored code
+ - **chore** - updating configs, workflows etc - does not impact code
 
 ### Improving The Documentation