Merge pull request elebumm#790 from elebumm/develop

2.2
Arush763 · Jul 1, 2022 · a9e6895 · a9e6895
2 parents f051459 + 51f47dc
commit a9e6895
Show file tree

Hide file tree

Showing 34 changed files with 1,111 additions and 740 deletions.
diff --git a/.env.template b/.env.template
@@ -1,31 +1,86 @@
-REDDIT_CLIENT_ID=""
-REDDIT_CLIENT_SECRET=""
 
-REDDIT_USERNAME=""
-REDDIT_PASSWORD=""
+REDDIT_CLIENT_ID="" #fFAGRNJru1FTz70BzhT3Zg
+#EXPLANATION the ID of your Reddit app of SCRIPT type
+#RANGE 12:30
+#MATCH_REGEX [-a-zA-Z0-9._~+/]+=*$
+#OOB_ERROR The ID should be over 12 and under 30 characters, double check your input.
 
-# If no, it will ask you a thread link to extract the thread, if yes it will randomize it. Default: "no"
+REDDIT_CLIENT_SECRET="" #fFAGRNJru1FTz70BzhT3Zg
+#EXPLANATION the SECRET of your Reddit app of SCRIPT type
+#RANGE 20:40
+#MATCH_REGEX [-a-zA-Z0-9._~+/]+=*$
+#OOB_ERROR The secret should be over 20 and under 40 characters, double check your input.
+
+REDDIT_USERNAME="" #asdfghjkl
+#EXPLANATION the username of your reddit account
+#RANGE 3:20
+#MATCH_REGEX [_0-9a-zA-Z]+$
+#OOB_ERROR A username HAS to be between 3 and 20 characters
+
+REDDIT_PASSWORD="" #fFAGRNJru1FTz70BzhT3Zg
+#EXPLANATION the password of your reddit account
+#RANGE 8:None
+#OOB_ERROR Password too short
+
+#OPTIONAL
 RANDOM_THREAD="no"
+# If set to no, it will ask you a thread link to extract the thread, if yes it will randomize it. Default: "no"
+
+REDDIT_2FA="" #no
+#MATCH_REGEX ^(yes|no)
+#EXPLANATION Whether you have Reddit 2FA enabled, Valid options are "yes" and "no"
 
-# Valid options are "yes" and "no" for the variable below
-REDDIT_2FA=""
 SUBREDDIT="AskReddit"
-# True or False
+#EXPLANATION what subreddit to pull posts from, the name of the sub, not the URL
+#RANGE 3:20
+#MATCH_REGEX [_0-9a-zA-Z]+$
+#OOB_ERROR A subreddit name HAS to be between 3 and 20 characters
+
 ALLOW_NSFW="False"
-# Used if you want to use a specific post. example of one is urdtfx
+#EXPLANATION Whether to allow NSFW content, True or False
+#MATCH_REGEX ^(True|False)$
+
 POST_ID=""
-#set to either LIGHT or DARK
-THEME="LIGHT"
-# used if you want to run multiple times. set to an int e.g. 4 or 29 and leave blank for 1
-TIMES_TO_RUN=""
-# max number of characters a comment can have.
-MAX_COMMENT_LENGTH="500" # default is 500
-# Range is 0 -> 1 recommended around 0.8-0.9
-OPACITY="1"
-
-# see different voice options: todo: add docs
-VOICE="Matthew" # e.g. en_us_002
-TTsChoice="polly"
+#MATCH_REGEX ^((?!://|://).)*$
+#EXPLANATION Used if you want to use a specific post. example of one is urdtfx
 
-# IN-PROGRESS - not yet implemented
+THEME="LIGHT" #dark
+#EXPLANATION sets the Reddit theme, either LIGHT or DARK
+#MATCH_REGEX ^(dark|light|DARK|LIGHT)$
+
+TIMES_TO_RUN="" #2
+#EXPLANATION used if you want to run multiple times. set to an int e.g. 4 or 29 and leave blank for 1
+
+MAX_COMMENT_LENGTH="500" #500
+#EXPLANATION max number of characters a comment can have. default is 500
+#RANGE 0:10000
+#MATCH_TYPE int
+#OOB_ERROR the max comment length should be between 0 and 10000
+
+OPACITY="1" #.8
+#EXPLANATION Sets the opacity of the comments when overlayed over the background
+#RANGE 0:1
+#MATCH_TYPE float
+#OOB_ERROR The opacity HAS to be between 0 and 1
+
+# If you want to translate the comments to another language, set the language code here.
+# If empty, no translation will be done.
+POSTLANG=""
+#EXPLANATION Activates the translation feature, set the language code for translate or leave blank
+
+TTSCHOICE="Polly"
+#EXPLANATION the backend used for TTS. Without anything specified, the user will be prompted to choose one.
+# IMPORTANT NOTE: if you use translate, you need to set this to googletranslate or tiktok and use custom voice in your language
+
+STREAMLABS_VOICE="Joanna"
+#EXPLANATION Sets the voice for the Streamlabs Polly TTS Engine. Check the file for more information on different voices.
+
+AWS_VOICE="Joanna"
+#EXPLANATION Sets the voice for the AWS Polly TTS Engine. Check the file for more information on different voices.
+
+TIKTOK_VOICE="en_us_006"
+#EXPLANATION Sets the voice for the TikTok TTS Engine. Check the file for more information on different voices.
+
+#OPTIONAL
 STORYMODE="False"
+# IN-PROGRESS - not yet implemented
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
@@ -20,9 +19,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **System (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - App version [e.g. 22]
+
+- Python Version: [e.g. Python 3.6]
+- OS: [e.g. Windows 11]
+- App version / Branch [e.g. latest, V2.0, master, develop ]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+# Description
+
+<!-- Please include a summary of the change and which issue is fixed. Please also include relevant context. List any dependencies that are required for this change. -->
+
+# Issue Fixes
+
+<!-- Fixes #(issue) if relevant-->
+
+None
+
+# Checklist:
+
+- [ ] I am pushing changes to the **develop** branch
+- [ ] I am using the recommended development environment
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have formatted and linted my code using python-black and pylint
+- [ ] I have cleaned up unnecessary files
+- [ ] My changes generate no new warnings
+- [ ] My changes follow the existing code-style
+- [ ] My changes are relevant to the project
+
+# Any other information (e.g how to test the changes)
+
+None
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-	- package-ecosystem: "pip" # See documentation for possible values
-		directory: "/" # Location of package manifests
-		schedule:
-			interval: "daily"
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -1,3 +1,4 @@
+
 # For most projects, this workflow file will not need changing; you simply need
 # to commit it to your repository.
 #
@@ -12,61 +13,61 @@
 name: "CodeQL"
 
 on:
-	push:
-		branches: [ "master" ]
-	pull_request:
-		# The branches below must be a subset of the branches above
-		branches: [ "master" ]
-	schedule:
-		- cron: '16 14 * * 3'
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '16 14 * * 3'
 
 jobs:
-	analyze:
-		name: Analyze
-		runs-on: ubuntu-latest
-		permissions:
-			actions: read
-			contents: read
-			security-events: write
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
 
-		strategy:
-			fail-fast: false
-			matrix:
-				language: [ 'python' ]
-				# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-				# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
 
-		steps:
-		- name: Checkout repository
-			uses: actions/checkout@v3
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
 
-		# Initializes the CodeQL tools for scanning.
-		- name: Initialize CodeQL
-			uses: github/codeql-action/init@v2
-			with:
-				languages: ${{ matrix.language }}
-				# If you wish to specify custom queries, you can do so here or in a config file.
-				# By default, queries listed here will override any specified in a config file.
-				# Prefix the list here with "+" to use these queries and those in the config file.
-
-				# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-				# queries: security-extended,security-and-quality
 
-
-		# Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-		# If this step fails, then you should remove it and run the build manually (see below)
-		- name: Autobuild
-			uses: github/codeql-action/autobuild@v2
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
 
-		# ℹ️ Command-line programs to run using the OS shell.
-		# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-		#   If the Autobuild fails above, remove it and uncomment the following three lines. 
-		#   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-		# - run: |
-		#   echo "Run, Build Application using script"
-		#   ./location_of_script_within_repo/buildscript.sh
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
 
-		- name: Perform CodeQL Analysis
-			uses: github/codeql-action/analyze@v2
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -0,0 +1,30 @@
+name: 'Stale issue handler'
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@main
+        id: stale
+        with:
+          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.'
+          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.'
+          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
+          stale-issue-label: 'stale'
+          close-pr-label: 'outdated'
+          close-issue-label: 'outdated'
+          stale-pr-label: 'stale'
+          exempt-pr-labes: 'keep,blocked,before next release,after next release'
+          exempt-issue-labels: 'enhancement,keep,blocked'
+          exempt-all-pr-milestones: true
+          exempt-all-issue-milestones: true
+      - name: Print outputs
+        run: echo ${{ join(steps.stale.outputs.*, ',') }}
+
diff --git a/.pylintrc b/.pylintrc
@@ -149,7 +149,7 @@ disable=raw-checker-failed,
         suppressed-message,
         useless-suppression,
         deprecated-pragma,
-        use-symbolic-message-instead
+        use-symbolic-message-instead,
         attribute-defined-outside-init,
         invalid-name,
         missing-docstring,