diff --git a/.env.template b/.env.template
index 5830840..77f2acf 100644
--- a/.env.template
+++ b/.env.template
@@ -1,29 +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.
-# Valid options are "yes" and "no"
-REDDIT_2FA=""
+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.
-#If no, it will ask you a thread link to extract the thread, if yes it will randomize it.
-RANDOM_THREAD="yes"
+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
-# Valid options are "light" and "dark"
-THEME=""
+REDDIT_PASSWORD="" #fFAGRNJru1FTz70BzhT3Zg
+#EXPLANATION the password of your reddit account
+#RANGE 8:None
+#OOB_ERROR Password too short
-# Enter a subreddit, e.g. "AskReddit"
-SUBREDDIT=""
+#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"
-# Filters the comments by range of lenght (min and max characters)
-# Min has to be less or equal to max
-# DO NOT INSERT ANY SPACES BETWEEN THE COMMA AND THE VALUES
-COMMENT_LENGTH_RANGE = "min,max"
+REDDIT_2FA="" #no
+#MATCH_REGEX ^(yes|no)
+#EXPLANATION Whether you have Reddit 2FA enabled, Valid options are "yes" and "no"
-# Range is 0 -> 1
-OPACITY="0.9"
+SUBREDDIT="AskReddit"
+#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
-# The absolute path of the folder where you want to save the final video
-# If empty or wrong, the path will be 'assets/'
-FINAL_VIDEO_PATH=""
\ No newline at end of file
+ALLOW_NSFW="False"
+#EXPLANATION Whether to allow NSFW content, True or False
+#MATCH_REGEX ^(True|False)$
+
+POST_ID=""
+#MATCH_REGEX ^((?!://|://).)*$
+#EXPLANATION Used if you want to use a specific post. example of one is urdtfx
+
+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/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..94f480d
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..fede9f8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+
+- 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/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..14b795a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered** (optional)
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context** (optional)
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..18e57b2
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,25 @@
+# Description
+
+
+
+# Issue Fixes
+
+
+
+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
new file mode 100644
index 0000000..ba1c6b8
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+ - 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
new file mode 100644
index 0000000..238dad4
--- /dev/null
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,73 @@
+
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+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'
+
+jobs:
+ 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
+
+ # 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
+
+ # âšī¸ 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.
+
+ # - run: |
+ # echo "Run, Build Application using script"
+ # ./location_of_script_within_repo/buildscript.sh
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
new file mode 100644
index 0000000..40f2245
--- /dev/null
+++ b/.github/workflows/stale.yml
@@ -0,0 +1,40 @@
+name: 'Stale issue handler'
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: '0 0 * * *'
+
+jobs:
+ stale:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/stale@main
+ id: stale-issue
+ name: stale-issue
+ 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.'
+ 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-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
+ id: stale-pr
+ name: stale-pr
+ with:
+ 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
+ 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
+
diff --git a/.gitignore b/.gitignore
index 97c134a..4ee3693 100644
--- a/.gitignore
+++ b/.gitignore
@@ -153,13 +153,91 @@ dmypy.json
cython_debug/
# PyCharm
-# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-# and can be added to the global gitignore or merged into this file. For a more nuclear
-# option (not recommended) you can uncomment the following to ignore the entire idea folder.
-.idea/
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn. Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
assets/
out
.DS_Store
-.setup-done-before
\ No newline at end of file
+.setup-done-before
+results/*
+reddit-bot-351418-5560ebc49cac.json
+/.idea
+*.pyc
+video_creation/data/videos.json
+video_creation/data/envvars.txt
diff --git a/.pylintrc b/.pylintrc
index e3fead7..b03c808 100644
--- 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,
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..385008b
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at the [discord server](https://discord.gg/yqNvvDMYpq).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 71a9aa8..ca1c7cb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,16 +8,22 @@ All types of contributions are encouraged and valued. See the [Table of Contents
>
> - â Star the project
> - đŖ Tweet about it
-> - đ˛ Refer this project in your project's readme
+> - đ˛ Refer this project in your project's readme
## Table of Contents
-- [I Have a Question](#i-have-a-question)
-- [I Want To Contribute](#i-want-to-contribute)
-- [Reporting Bugs](#reporting-bugs)
-- [Suggesting Enhancements](#suggesting-enhancements)
-- [Your First Code Contribution](#your-first-code-contribution)
-- [Improving The Documentation](#improving-the-documentation)
+- [Contributing to Reddit Video Maker Bot đĨ](#contributing-to-reddit-video-maker-bot-)
+ - [Table of Contents](#table-of-contents)
+ - [I Have a Question](#i-have-a-question)
+ - [I Want To Contribute](#i-want-to-contribute)
+ - [Reporting Bugs](#reporting-bugs)
+ - [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
+ - [Suggesting Enhancements](#suggesting-enhancements)
+ - [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
+ - [Your First Code Contribution](#your-first-code-contribution)
+ - [Your environment](#your-environment)
+ - [Making your first PR](#making-your-first-pr)
+ - [Improving The Documentation](#improving-the-documentation)
## I Have a Question
@@ -38,6 +44,7 @@ Additionally, there is a [Discord Server](https://discord.gg/swqtb7AsNQ) for any
## I Want To Contribute
### Reporting Bugs
+
Before Submitting a Bug Report
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
@@ -51,9 +58,9 @@ A good bug report shouldn't leave others needing to chase you up for more inform
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Your input and the output
- - Is the issue reproducable? Does it exist in previous versions?
-
-
How Do I Submit a Good Bug Report?
+ - Is the issue reproducible? Does it exist in previous versions?
+
+#### How Do I Submit a Good Bug Report?
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
@@ -65,7 +72,7 @@ We use GitHub issues to track bugs and errors. If you run into an issue with the
Once it's filed:
- The project team will label the issue accordingly.
-- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will try to support you as best as they can, but you may not recieve an instant.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will try to support you as best as they can, but you may not receive an instant.
- If the team discovers that this is an issue it will be marked `bug` or `error`, as well as possibly other tags relating to the nature of the error), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
@@ -104,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 #\") in your pull request.
+- You link any issues that are resolved or fixed by your changes. (this is done by typing "Fixes #\") 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
diff --git a/LICENSE b/LICENSE
index b477f17..3b721eb 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,190 +1,190 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+Copyright (C) 2007 Free Software Foundation, Inc.
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
Preamble
- The GNU General Public License is a free, copyleft license for
+The GNU General Public License is a free, copyleft license for
software and other kinds of works.
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
+software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
+any other work released this way by its authors. You can apply it to
your programs, too.
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
- For example, if you distribute copies of such a program, whether
+For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
know their rights.
- Developers that use the GNU GPL protect your rights with two steps:
+Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
- Some devices are designed to deny users access to install or run
+Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
+use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
+products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
- Finally, every program is threatened constantly by software patents.
+Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
+make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
- The precise terms and conditions for copying, distribution and
+The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
- 0. Definitions.
+0. Definitions.
- "This License" refers to version 3 of the GNU General Public License.
+"This License" refers to version 3 of the GNU General Public License.
- "Copyright" also means copyright-like laws that apply to other kinds of
+"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
- To "modify" a work means to copy from or adapt all or part of the work
+To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
+exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
- A "covered work" means either the unmodified Program or a work based
+A "covered work" means either the unmodified Program or a work based
on the Program.
- To "propagate" a work means to do anything with it that, without
+To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
+computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
- An interactive user interface displays "Appropriate Legal Notices"
+An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
+work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
- 1. Source Code.
+1. Source Code.
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
+The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
form of a work.
- A "Standard Interface" means an interface that either is an official
+A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
- The "System Libraries" of an executable work include anything, other
+The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
+implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
- The "Corresponding Source" for a work in object code form means all
+The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
+control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
+which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
- The Corresponding Source need not include anything that users
+The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
- The Corresponding Source for a work in source code form is that
+The Corresponding Source for a work in source code form is that
same work.
- 2. Basic Permissions.
+2. Basic Permissions.
- All rights granted under this License are granted for the term of
+All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
+content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
- You may make, run and propagate covered works that you do not
+You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
+in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
+not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
+Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
- No covered work shall be deemed part of an effective technological
+No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
- When you convey a covered work, you waive any legal power to forbid
+When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
@@ -192,9 +192,9 @@ modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
- 4. Conveying Verbatim Copies.
+4. Conveying Verbatim Copies.
- You may convey verbatim copies of the Program's source code as you
+You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
@@ -202,12 +202,12 @@ non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
- You may charge any price or no price for each copy that you convey,
+You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
- 5. Conveying Modified Source Versions.
+5. Conveying Modified Source Versions.
- You may convey a work based on the Program, or the modifications to
+You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
@@ -232,19 +232,19 @@ terms of section 4, provided that you also meet all of these conditions:
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
- A compilation of a covered work with other separate and independent
+A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
+beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
- 6. Conveying Non-Source Forms.
+6. Conveying Non-Source Forms.
- You may convey a covered work in object code form under the terms
+You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
@@ -290,75 +290,75 @@ in one of these ways:
Source of the work are being offered to the general public at no
charge under subsection 6d.
- A separable portion of the object code, whose source code is excluded
+A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
- A "User Product" is either (1) a "consumer product", which means any
+A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
+actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
- "Installation Information" for a User Product means any methods,
+"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
+a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
- If you convey an object code work under this section in, or with, or
+If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
+by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
- The requirement to provide Installation Information does not include a
+The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
+the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
- Corresponding Source conveyed, and Installation Information provided,
+Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
- 7. Additional Terms.
+7. Additional Terms.
- "Additional permissions" are terms that supplement the terms of this
+"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
+that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
- When you convey a copy of a covered work, you may at your option
+When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
- Notwithstanding any other provision of this License, for material you
+Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
@@ -385,74 +385,74 @@ that material) supplement the terms of this License with terms:
any liability that these contractual assumptions directly impose on
those licensors and authors.
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
+restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
- If you add terms to a covered work in accord with this section, you
+If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
- Additional terms, permissive or non-permissive, may be stated in the
+Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
- 8. Termination.
+8. Termination.
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
- However, if you cease all violation of this License, then your
+However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
- Moreover, your license from a particular copyright holder is
+Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
- Termination of your rights under this section does not terminate the
+Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
+this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
- 9. Acceptance Not Required for Having Copies.
+9. Acceptance Not Required for Having Copies.
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
+You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
+to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
- 10. Automatic Licensing of Downstream Recipients.
+10. Automatic Licensing of Downstream Recipients.
- Each time you convey a covered work, the recipient automatically
+Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
+propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
- An "entity transaction" is a transaction transferring control of an
+An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
+organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
@@ -460,43 +460,43 @@ give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
- 11. Patents.
+11. Patents.
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
- A contributor's "essential patent claims" are all patent claims
+A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
+consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
- Each contributor grants you a non-exclusive, worldwide, royalty-free
+Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
- In the following three paragraphs, a "patent license" is any express
+In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
+sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
- If you convey a covered work, knowingly relying on a patent license,
+If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
@@ -504,13 +504,13 @@ then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
+license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
- If, pursuant to or in connection with a single transaction or
+If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
@@ -518,10 +518,10 @@ or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
- A patent license is "discriminatory" if it does not include within
+A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
+specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
@@ -533,73 +533,73 @@ for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
- Nothing in this License shall be construed as excluding or limiting
+Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
- 12. No Surrender of Others' Freedom.
+12. No Surrender of Others' Freedom.
- If conditions are imposed on you (whether by court order, agreement or
+If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
+excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
+not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
- 13. Use with the GNU Affero General Public License.
+13. Use with the GNU Affero General Public License.
- Notwithstanding any other provision of this License, you have
+Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
+combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
- 14. Revised Versions of this License.
+14. Revised Versions of this License.
- The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time. Such new versions will
+The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
- Each version is given a distinguishing version number. If the
+Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
+Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
- If the Program specifies that a proxy can decide which future
+If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
- 15. Disclaimer of Warranty.
+15. Disclaimer of Warranty.
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
- 16. Limitation of Liability.
+16. Limitation of Liability.
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
@@ -609,9 +609,9 @@ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
- 17. Interpretation of Sections 15 and 16.
+17. Interpretation of Sections 15 and 16.
- If the disclaimer of warranty and limitation of liability provided
+If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
@@ -622,11 +622,11 @@ copy of the Program in return for a fee.
How to Apply These Terms to Your New Programs
- If you develop a new program, and you want it to be of the greatest
+If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
- To do so, attach the following notices to the program. It is safest
+To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
@@ -649,7 +649,7 @@ the "copyright" line and a pointer to where the full notice is found.
Also add information on how to contact you by electronic and paper mail.
- If the program does terminal interaction, make it output a short
+If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
@@ -658,17 +658,17 @@ notice like this when it starts in an interactive mode:
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
+parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
- You should also get your employer (if you work as a programmer) or school,
+You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
- The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you
+The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
-the library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License. But first, please read
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
.
diff --git a/README.md b/README.md
index b683be5..dc6237c 100644
--- a/README.md
+++ b/README.md
@@ -1,49 +1,56 @@
# Reddit Video Maker Bot đĨ
-https://user-images.githubusercontent.com/6053155/170525726-2db23ae0-97b8-4bd1-8c95-00da60ce099f.mp4
-
All done WITHOUT video editing or asset compiling. Just pure â¨programming magicâ¨.
Created by Lewis Menelaws & [TMRRW](https://tmrrwinc.ca)
-[
+
+
-](https://tmrrwinc.ca)
+
+
+
+
+## Video Explainer
+
+[
+](https://www.youtube.com/watch?v=3gjcY_00U1w)
## Motivation đ¤
-These videos on TikTok, YouTube and Instagram get MILLIONS of views across all platforms and require very little effort. The only original thing being done is the editing and gathering of all materials...
+These videos on TikTok, YouTube and Instagram get MILLIONS of views across all platforms and require very little effort.
+The only original thing being done is the editing and gathering of all materials...
... but what if we can automate that process? đ¤
## Disclaimers đ¨
-- This is purely for fun purposes.
-- **At the moment**, this repository won't attempt to upload this content through this bot. It will give you a file that you will then have to upload manually. This is for the sake of avoiding any sort of community guideline issues.
+- **At the moment**, this repository won't attempt to upload this content through this bot. It will give you a file that
+ you will then have to upload manually. This is for the sake of avoiding any sort of community guideline issues.
## Requirements
-- Python 3.6+
-- Playwright (this should install automatically during installation)
+- Python 3.9+
+- Playwright (this should install automatically in installation)
## Installation đŠâđģ
1. Clone this repository
-2. Run `pip3 install -r requirements.txt`
-3. Run `python3 -m playwright install` and `python3 -m playwright install-deps`.
-4.
- 4a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant.
+2. Run `pip install -r requirements.txt`
- 4b **Manual Install**: Rename `.env.template` to `.env` and replace all values with the appropriate fields. To get Reddit keys (**required**), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script". Copy your keys into the `.env` file, along with whether your account uses two-factor authentication.
+3. Run `playwright install` and `playwright install-deps`. (if this fails try adding python -m to the front of the command)
-5. Run `python3 main.py` (unless you chose automatic install, then the installer will automatically run main.py)
-7. Enjoy đ
+4. Run `python main.py`
+ required\*\*), visit [the Reddit Apps page.](https://www.reddit.com/prefs/apps) TL;DR set up an app that is a "script".
+5. Enjoy đ
+(Note if you got an error installing or running the bot try first rerunning the command with a three after the name e.g. python3 or pip3)
-If you want to see more detailed guide, please refer to the official [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/).
-\*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
+## Video
+
+https://user-images.githubusercontent.com/66544866/173453972-6526e4e6-c6ef-41c5-ab40-5d275e724e7c.mp4
## Contributing & Ways to improve đ
@@ -51,13 +58,14 @@ In its current state, this bot does exactly what it needs to do. However, lots o
I have tried to simplify the code so anyone can read it and start contributing at any skill level. Don't be shy :) contribute!
-To-Do:
-
-- [x] Allowing users to choose a reddit thread instead of being randomized.
-- [x] Allowing users to choose a background that is picked instead of the Minecraft one.
-- [x] Allowing users to choose between any subreddit.
-- [ ] Allowing users to change voice.
-- [ ] Creating better documentation and adding a command line interface.
+- [ ] Creating better documentation and adding a command line interface.
+- [x] Allowing users to choose a reddit thread instead of being randomized.
+- [x] Allowing users to choose a background that is picked instead of the Minecraft one.
+- [x] Allowing users to choose between any subreddit.
+- [x] Allowing users to change voice.
+- [x] Checks if a video has already been created
+- [x] Light and Dark modes
+- [x] NSFW post filter
Please read our [contributing guidelines](CONTRIBUTING.md) for more detailed information.
@@ -65,10 +73,12 @@ Please read our [contributing guidelines](CONTRIBUTING.md) for more detailed inf
Elebumm (Lewis#6305) - https://github.com/elebumm (Founder)
-CallumIO - https://github.com/CallumIO
+Jason (JasonLovesDoggo#1904) - https://github.com/JasonLovesDoggo
+
+CallumIO (c.#6837) - https://github.com/CallumIO
HarryDaDev (hrvyy#9677) - https://github.com/ImmaHarry
LukaHietala (Pix.#0001) - https://github.com/LukaHietala
-Freebiell - https://github.com/FreebieII
+Freebiell (Freebie#6429) - https://github.com/FreebieII
diff --git a/TTS/GTTS.py b/TTS/GTTS.py
new file mode 100644
index 0000000..992eeb5
--- /dev/null
+++ b/TTS/GTTS.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+import random
+import os
+from gtts import gTTS
+
+max_chars = 0
+
+
+class GTTS:
+ def __init__(self):
+ self.max_chars = 0
+ self.voices = []
+
+ def run(self, text, filepath):
+ tts = gTTS(text=text, lang=os.getenv("POSTLANG") or "en", slow=False)
+ tts.save(filepath)
+
+ def randomvoice(self):
+ return random.choice(self.voices)
diff --git a/TTS/TikTok.py b/TTS/TikTok.py
new file mode 100644
index 0000000..91ba526
--- /dev/null
+++ b/TTS/TikTok.py
@@ -0,0 +1,98 @@
+import base64
+import os
+import random
+import requests
+from requests.adapters import HTTPAdapter, Retry
+
+# from profanity_filter import ProfanityFilter
+# pf = ProfanityFilter()
+# Code by @JasonLovesDoggo
+# https://twitter.com/scanlime/status/1512598559769702406
+
+nonhuman = [ # DISNEY VOICES
+ "en_us_ghostface", # Ghost Face
+ "en_us_chewbacca", # Chewbacca
+ "en_us_c3po", # C3PO
+ "en_us_stitch", # Stitch
+ "en_us_stormtrooper", # Stormtrooper
+ "en_us_rocket", # Rocket
+ # ENGLISH VOICES
+]
+human = [
+ "en_au_001", # English AU - Female
+ "en_au_002", # English AU - Male
+ "en_uk_001", # English UK - Male 1
+ "en_uk_003", # English UK - Male 2
+ "en_us_001", # English US - Female (Int. 1)
+ "en_us_002", # English US - Female (Int. 2)
+ "en_us_006", # English US - Male 1
+ "en_us_007", # English US - Male 2
+ "en_us_009", # English US - Male 3
+ "en_us_010",
+]
+voices = nonhuman + human
+
+noneng = [
+ "fr_001", # French - Male 1
+ "fr_002", # French - Male 2
+ "de_001", # German - Female
+ "de_002", # German - Male
+ "es_002", # Spanish - Male
+ # AMERICA VOICES
+ "es_mx_002", # Spanish MX - Male
+ "br_001", # Portuguese BR - Female 1
+ "br_003", # Portuguese BR - Female 2
+ "br_004", # Portuguese BR - Female 3
+ "br_005", # Portuguese BR - Male
+ # ASIA VOICES
+ "id_001", # Indonesian - Female
+ "jp_001", # Japanese - Female 1
+ "jp_003", # Japanese - Female 2
+ "jp_005", # Japanese - Female 3
+ "jp_006", # Japanese - Male
+ "kr_002", # Korean - Male 1
+ "kr_003", # Korean - Female
+ "kr_004", # Korean - Male 2
+]
+
+
+# good_voices = {'good': ['en_us_002', 'en_us_006'],
+# 'ok': ['en_au_002', 'en_uk_001']} # less en_us_stormtrooper more less en_us_rocket en_us_ghostface
+
+
+class TikTok: # TikTok Text-to-Speech Wrapper
+ def __init__(self):
+ self.URI_BASE = (
+ "https://api16-normal-useast5.us.tiktokv.com/media/api/text/speech/invoke/?text_speaker="
+ )
+ self.max_chars = 300
+ self.voices = {"human": human, "nonhuman": nonhuman, "noneng": noneng}
+
+ def run(self, text, filepath, random_voice: bool = False):
+ # if censor:
+ # req_text = pf.censor(req_text)
+ # pass
+ voice = (
+ self.randomvoice()
+ if random_voice
+ else (os.getenv("TIKTOK_VOICE") or random.choice(self.voices["human"]))
+ )
+ try:
+ r = requests.post(f"{self.URI_BASE}{voice}&req_text={text}&speaker_map_type=0")
+ except requests.exceptions.SSLError:
+ # https://stackoverflow.com/a/47475019/18516611
+ session = requests.Session()
+ retry = Retry(connect=3, backoff_factor=0.5)
+ adapter = HTTPAdapter(max_retries=retry)
+ session.mount("http://", adapter)
+ session.mount("https://", adapter)
+ r = session.post(f"{self.URI_BASE}{voice}&req_text={text}&speaker_map_type=0")
+ # print(r.text)
+ vstr = [r.json()["data"]["v_str"]][0]
+ b64d = base64.b64decode(vstr)
+
+ with open(filepath, "wb") as out:
+ out.write(b64d)
+
+ def randomvoice(self):
+ return random.choice(self.voices["human"])
diff --git a/TTS/__init__.py b/TTS/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/TTS/aws_polly.py b/TTS/aws_polly.py
new file mode 100644
index 0000000..6cbe4c5
--- /dev/null
+++ b/TTS/aws_polly.py
@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+from boto3 import Session
+from botocore.exceptions import BotoCoreError, ClientError
+import sys
+import os
+import random
+
+voices = [
+ "Brian",
+ "Emma",
+ "Russell",
+ "Joey",
+ "Matthew",
+ "Joanna",
+ "Kimberly",
+ "Amy",
+ "Geraint",
+ "Nicole",
+ "Justin",
+ "Ivy",
+ "Kendra",
+ "Salli",
+ "Raveena",
+]
+
+
+class AWSPolly:
+ def __init__(self):
+ self.max_chars = 0
+ self.voices = voices
+
+ def run(self, text, filepath, random_voice: bool = False):
+ session = Session(profile_name="polly")
+ polly = session.client("polly")
+ if random_voice:
+ voice = self.randomvoice()
+ else:
+ if not os.getenv("AWS_VOICE"):
+ return ValueError(
+ f"Please set the environment variable AWS_VOICE to a valid voice. options are: {voices}"
+ )
+ voice = str(os.getenv("AWS_VOICE")).capitalize()
+ try:
+ # Request speech synthesis
+ response = polly.synthesize_speech(
+ Text=text, OutputFormat="mp3", VoiceId=voice, Engine="neural"
+ )
+ except (BotoCoreError, ClientError) as error:
+ # The service returned an error, exit gracefully
+ print(error)
+ sys.exit(-1)
+
+ # Access the audio stream from the response
+ if "AudioStream" in response:
+ file = open(filepath, "wb")
+ file.write(response["AudioStream"].read())
+ file.close()
+ # print_substep(f"Saved Text {idx} to MP3 files successfully.", style="bold green")
+
+ else:
+ # The response didn't contain audio data, exit gracefully
+ print("Could not stream audio")
+ sys.exit(-1)
+
+ def randomvoice(self):
+ return random.choice(self.voices)
diff --git a/TTS/engine_wrapper.py b/TTS/engine_wrapper.py
new file mode 100644
index 0000000..13ff850
--- /dev/null
+++ b/TTS/engine_wrapper.py
@@ -0,0 +1,118 @@
+#!/usr/bin/env python3
+from pathlib import Path
+from typing import Tuple
+import re
+from os import getenv
+
+# import sox
+# from mutagen import MutagenError
+# from mutagen.mp3 import MP3, HeaderNotFoundError
+import translators as ts
+from rich.progress import track
+from moviepy.editor import AudioFileClip, CompositeAudioClip, concatenate_audioclips
+from utils.console import print_step, print_substep
+from utils.voice import sanitize_text
+
+DEFUALT_MAX_LENGTH: int = 50 # video length variable
+
+
+class TTSEngine:
+
+ """Calls the given TTS engine to reduce code duplication and allow multiple TTS engines.
+
+ Args:
+ tts_module : The TTS module. Your module should handle the TTS itself and saving to the given path under the run method.
+ reddit_object : The reddit object that contains the posts to read.
+ path (Optional) : The unix style path to save the mp3 files to. This must not have leading or trailing slashes.
+ max_length (Optional) : The maximum length of the mp3 files in total.
+
+ Notes:
+ tts_module must take the arguments text and filepath.
+ """
+
+ def __init__(
+ self,
+ tts_module,
+ reddit_object: dict,
+ path: str = "assets/temp/mp3",
+ max_length: int = DEFUALT_MAX_LENGTH,
+ ):
+ self.tts_module = tts_module()
+ self.reddit_object = reddit_object
+ self.path = path
+ self.max_length = max_length
+ self.length = 0
+
+ def run(self) -> Tuple[int, int]:
+
+ Path(self.path).mkdir(parents=True, exist_ok=True)
+
+ # This file needs to be removed in case this post does not use post text, so that it wont appear in the final video
+ try:
+ Path(f"{self.path}/posttext.mp3").unlink()
+ except OSError:
+ pass
+
+ print_step("Saving Text to MP3 files...")
+
+ self.call_tts("title", self.reddit_object["thread_title"])
+ if self.reddit_object["thread_post"] != "" and getenv("STORYMODE", "").casefold() == "true":
+ self.call_tts("posttext", self.reddit_object["thread_post"])
+
+ idx = None
+ for idx, comment in track(enumerate(self.reddit_object["comments"]), "Saving..."):
+ # ! Stop creating mp3 files if the length is greater than max length.
+ if self.length > self.max_length:
+ break
+ if not self.tts_module.max_chars:
+ self.call_tts(f"{idx}", comment["comment_body"])
+ else:
+ self.split_post(comment["comment_body"], idx)
+
+ print_substep("Saved Text to MP3 files successfully.", style="bold green")
+ return self.length, idx
+
+ def split_post(self, text: str, idx: int):
+ split_files = []
+ split_text = [
+ x.group().strip()
+ for x in re.finditer(rf" *((.{{0,{self.tts_module.max_chars}}})(\.|.$))", text)
+ ]
+
+ idy = None
+ for idy, text_cut in enumerate(split_text):
+ # print(f"{idx}-{idy}: {text_cut}\n")
+ self.call_tts(f"{idx}-{idy}.part", text_cut)
+ split_files.append(AudioFileClip(f"{self.path}/{idx}-{idy}.part.mp3"))
+ CompositeAudioClip([concatenate_audioclips(split_files)]).write_audiofile(
+ f"{self.path}/{idx}.mp3", fps=44100, verbose=False, logger=None
+ )
+
+ for i in split_files:
+ name = i.filename
+ i.close()
+ Path(name).unlink()
+
+ # for i in range(0, idy + 1):
+ # print(f"Cleaning up {self.path}/{idx}-{i}.part.mp3")
+
+ # Path(f"{self.path}/{idx}-{i}.part.mp3").unlink()
+
+ def call_tts(self, filename: str, text: str):
+ self.tts_module.run(text=process_text(text), filepath=f"{self.path}/{filename}.mp3")
+ # try:
+ # self.length += MP3(f"{self.path}/{filename}.mp3").info.length
+ # except (MutagenError, HeaderNotFoundError):
+ # self.length += sox.file_info.duration(f"{self.path}/{filename}.mp3")
+ clip = AudioFileClip(f"{self.path}/{filename}.mp3")
+ self.length += clip.duration
+ clip.close()
+
+def process_text(text: str):
+ lang = getenv("POSTLANG", "")
+ new_text = sanitize_text(text)
+ if lang:
+ print_substep("Translating Text...")
+ translated_text = ts.google(text, to_language=lang)
+ new_text = sanitize_text(translated_text)
+ return new_text
diff --git a/TTS/streamlabs_polly.py b/TTS/streamlabs_polly.py
new file mode 100644
index 0000000..066fa53
--- /dev/null
+++ b/TTS/streamlabs_polly.py
@@ -0,0 +1,60 @@
+import random
+import os
+import requests
+from requests.exceptions import JSONDecodeError
+
+voices = [
+ "Brian",
+ "Emma",
+ "Russell",
+ "Joey",
+ "Matthew",
+ "Joanna",
+ "Kimberly",
+ "Amy",
+ "Geraint",
+ "Nicole",
+ "Justin",
+ "Ivy",
+ "Kendra",
+ "Salli",
+ "Raveena",
+]
+
+
+# valid voices https://lazypy.ro/tts/
+
+
+class StreamlabsPolly:
+ def __init__(self):
+ self.url = "https://streamlabs.com/polly/speak"
+ self.max_chars = 550
+ self.voices = voices
+
+ def run(self, text, filepath, random_voice: bool = False):
+ if random_voice:
+ voice = self.randomvoice()
+ else:
+ if not os.getenv("STREAMLABS_VOICE"):
+ return ValueError(
+ f"Please set the environment variable STREAMLABS_VOICE to a valid voice. options are: {voices}"
+ )
+ voice = str(os.getenv("STREAMLABS_VOICE")).capitalize()
+ body = {"voice": voice, "text": text, "service": "polly"}
+ response = requests.post(self.url, data=body)
+ try:
+ voice_data = requests.get(response.json()["speak_url"])
+ with open(filepath, "wb") as f:
+ f.write(voice_data.content)
+ except (KeyError, JSONDecodeError):
+ try:
+ if response.json()["error"] == "No text specified!":
+ raise ValueError("Please specify a text to convert to speech.")
+ except (KeyError, JSONDecodeError):
+ print("Error occurred calling Streamlabs Polly")
+
+ def randomvoice(self):
+ return random.choice(self.voices)
+
+
+# StreamlabsPolly().run(text=str('hi hi ' * 92)[1:], filepath='hello.mp3', random_voice=True)
diff --git a/examples/final_video.mp4 b/examples/final_video.mp4
index a04df6d..cd19420 100644
Binary files a/examples/final_video.mp4 and b/examples/final_video.mp4 differ
diff --git a/examples/final_video.webm b/examples/final_video.webm
deleted file mode 100644
index be9d2fc..0000000
Binary files a/examples/final_video.webm and /dev/null differ
diff --git a/main.py b/main.py
old mode 100644
new mode 100755
index cade990..e362aad
--- a/main.py
+++ b/main.py
@@ -1,100 +1,75 @@
-#!/usr/bin/env python3
-# Main
-from utils.console import print_markdown
-from rich.console import Console
-import time
+#!/usr/bin/env python
+import math
+from subprocess import Popen
+from os import getenv, name
+from dotenv import load_dotenv
from reddit.subreddit import get_subreddit_threads
+from utils.cleanup import cleanup
+from utils.console import print_markdown, print_step
+from utils.checker import check_env
+
+# from utils.checker import envUpdate
from video_creation.background import download_background, chop_background_video
-from video_creation.voices import save_text_to_mp3
-from video_creation.screenshot_downloader import download_screenshots_of_reddit_posts
from video_creation.final_video import make_final_video
-from dotenv import load_dotenv
-import os
-
-console = Console()
-
-configured = True
-REQUIRED_VALUES = [
- "REDDIT_CLIENT_ID",
- "REDDIT_CLIENT_SECRET",
- "REDDIT_USERNAME",
- "REDDIT_PASSWORD",
- "OPACITY",
-]
-
+from video_creation.screenshot_downloader import download_screenshots_of_reddit_posts
+from video_creation.voices import save_text_to_mp3
+VERSION = "2.2.2"
+print(
+ """
+âââââââ âââââââââââââââ âââââââ ââââââââââââ âââ âââââââââââââ ââââââââ âââââââ ââââ ââââ ââââââ âââ ââââââââââââââââââ
+ââââââââââââââââââââââââââââââââââââââââââââ âââ âââââââââââââââââââââââââââââââ âââââ ââââââââââââââââ ââââââââââââââââââââ
+ââââââââââââââ âââ ââââââ ââââââ âââ âââ âââââââââ âââââââââ âââ âââ ââââââââââââââââââââââââââ ââââââ ââââââââ
+ââââââââââââââ âââ ââââââ ââââââ âââ ââââ ââââââââââ âââââââââ âââ âââ ââââââââââââââââââââââââââ ââââââ ââââââââ
+âââ ââââââââââââââââââââââââââââââ âââ âââââââ ââââââââââââââââââââââââââââ âââ âââ ââââââ ââââââ ââââââââââââââ âââ
+âââ ââââââââââââââââââ âââââââ âââ âââ âââââ ââââââââââ ââââââââ âââââââ âââ ââââââ ââââââ ââââââââââââââ âââ
+"""
+)
+# Modified by JasonLovesDoggo
print_markdown(
- "### Thanks for using this tool! [Feel free to contribute to this project on GitHub!](https://lewismenelaws.com) If you have any questions, feel free to reach out to me on Twitter or submit a GitHub issue."
+ "### Thanks for using this tool! [Feel free to contribute to this project on GitHub!](https://lewismenelaws.com) If you have any questions, feel free to reach out to me on Twitter or submit a GitHub issue. You can find solutions to many common problems in the [Documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/)"
)
+print_step(f"You are using V{VERSION} of the bot")
-"""
-
-Load .env file if exists. If it doesnt exist, print a warning and launch the setup wizard.
-If there is a .env file, check if the required variables are set. If not, print a warning and launch the setup wizard.
-
-"""
-
-client_id = os.getenv("REDDIT_CLIENT_ID")
-client_secret = os.getenv("REDDIT_CLIENT_SECRET")
-username = os.getenv("REDDIT_USERNAME")
-password = os.getenv("REDDIT_PASSWORD")
-reddit2fa = os.getenv("REDDIT_2FA")
-
-load_dotenv()
+def main(POST_ID=None):
+ cleanup()
+ reddit_object = get_subreddit_threads(POST_ID)
+ length, number_of_comments = save_text_to_mp3(reddit_object)
+ length = math.ceil(length)
+ download_screenshots_of_reddit_posts(reddit_object, number_of_comments)
+ download_background()
+ chop_background_video(length)
+ make_final_video(number_of_comments, length, reddit_object)
-console.log("[bold green]Checking environment variables...")
-time.sleep(1)
+def run_many(times):
+ for x in range(1, times + 1):
+ print_step(
+ f'on the {x}{("st" if x == 1 else ("nd" if x == 2 else ("rd" if x == 3 else "th")))} iteration of {times}'
+ ) # correct 1st 2nd 3rd 4th 5th....
+ main()
+ Popen("cls" if name == "nt" else "clear", shell=True).wait()
-if not os.path.exists(".env"):
- configured = False
- console.log("[red] Your .env file is invalid, or was never created. Standby.")
-for val in REQUIRED_VALUES:
- # print(os.getenv(val))
- if val not in os.environ or not os.getenv(val):
- console.log(f'[bold red]Missing Variable: "{val}"')
- configured = False
- console.log(
- "[red]Looks like you need to set your Reddit credentials in the .env file. Please follow the instructions in the README.md file to set them up."
- )
- time.sleep(0.5)
- console.log(
- "[red]We can also launch the easy setup wizard. type yes to launch it, or no to quit the program."
- )
- setup_ask = input("Launch setup wizard? > ")
- if setup_ask == "yes":
- console.log("[bold green]Here goes nothing! Launching setup wizard...")
- time.sleep(0.5)
- os.system("python3 setup.py")
+if __name__ == "__main__":
+ if check_env() is not True:
+ exit()
+ load_dotenv()
+ try:
+ if getenv("TIMES_TO_RUN") and isinstance(int(getenv("TIMES_TO_RUN")), int):
+ run_many(int(getenv("TIMES_TO_RUN")))
- elif setup_ask == "no":
- console.print("[red]Exiting...")
- time.sleep(0.5)
- exit()
+ elif len(getenv("POST_ID", "").split("+")) > 1:
+ for index, post_id in enumerate(getenv("POST_ID", "").split("+")):
+ index += 1
+ print_step(
+ f'on the {index}{("st" if index == 1 else ("nd" if index == 2 else ("rd" if index == 3 else "th")))} post of {len(getenv("POST_ID", "").split("+"))}'
+ )
+ main(post_id)
+ Popen("cls" if name == "nt" else "clear", shell=True).wait()
else:
- console.print("[red]I don't understand that. Exiting...")
- time.sleep(0.5)
- exit()
-try:
- float(os.getenv("OPACITY"))
-except ValueError:
- console.log(
- "[red]Please ensure that OPACITY is set between 0 and 1 in your .env file"
- )
- configured = False
- exit()
-console.log("[bold green]Enviroment Variables are set! Continuing...")
-
-if configured:
- reddit_object = get_subreddit_threads()
- length, number_of_comments = save_text_to_mp3(reddit_object)
- download_screenshots_of_reddit_posts(
- reddit_object, number_of_comments, os.getenv("THEME", "light")
- )
- while True:
- vidpath = download_background(length)
- noerror = chop_background_video(length, vidpath)
- if noerror is True:
- break
- final_video = make_final_video(number_of_comments)
+ main()
+ except KeyboardInterrupt:
+ print_markdown("## Clearing temp files")
+ cleanup()
+ exit()
diff --git a/reddit/subreddit.py b/reddit/subreddit.py
index 40c95b6..e1f8940 100644
--- a/reddit/subreddit.py
+++ b/reddit/subreddit.py
@@ -1,85 +1,100 @@
-from numpy import Infinity
-from rich.console import Console
-from utils.console import print_step, print_substep, print_markdown
-from dotenv import load_dotenv
-import os
-import random
-import praw
import re
+from os import getenv
+
+import praw
+from praw.models import MoreComments
-console = Console()
+from utils.console import print_step, print_substep
+from utils.subreddit import get_subreddit_undone
+from utils.videos import check_done
-def get_subreddit_threads():
- global submission
+def get_subreddit_threads(POST_ID: str):
"""
- Returns a list of threads from the provided subreddit.
+ Returns a list of threads from the AskReddit subreddit.
"""
- load_dotenv()
+ print_substep("Logging into Reddit.")
- if os.getenv("REDDIT_2FA", default="no").casefold() == "yes":
- print(
- "\nEnter your two-factor authentication code from your authenticator app.\n"
- )
+ content = {}
+ if str(getenv("REDDIT_2FA")).casefold() == "yes":
+ print("\nEnter your two-factor authentication code from your authenticator app.\n")
code = input("> ")
print()
- pw = os.getenv("REDDIT_PASSWORD")
+ pw = getenv("REDDIT_PASSWORD")
passkey = f"{pw}:{code}"
else:
- passkey = os.getenv("REDDIT_PASSWORD")
-
- content = {}
+ passkey = getenv("REDDIT_PASSWORD")
+ username = getenv("REDDIT_USERNAME")
+ if username.casefold().startswith("u/"):
+ username = username[2:]
reddit = praw.Reddit(
- client_id=os.getenv("REDDIT_CLIENT_ID"),
- client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
- user_agent="Accessing subreddit threads",
- username=os.getenv("REDDIT_USERNAME"),
- password=passkey,
+ client_id=getenv("REDDIT_CLIENT_ID"),
+ client_secret=getenv("REDDIT_CLIENT_SECRET"),
+ user_agent="Accessing Reddit threads",
+ username=username,
+ passkey=passkey,
+ check_for_async=False,
)
- # If the user specifies that he doesnt want a random thread, or if he doesn't insert the "RANDOM_THREAD" variable at all, ask the thread link
- if not os.getenv("RANDOM_THREAD") or os.getenv("RANDOM_THREAD") == "no":
- print_substep("Insert the full thread link:", style="bold green")
- thread_link = input()
- print_step("Getting the inserted thread...")
- submission = reddit.submission(url=thread_link)
+ # Ask user for subreddit input
+ print_step("Getting subreddit threads...")
+ if not getenv(
+ "SUBREDDIT"
+ ): # note to user. you can have multiple subreddits via reddit.subreddit("redditdev+learnpython")
+ try:
+ subreddit = reddit.subreddit(
+ re.sub(r"r\/", "", input("What subreddit would you like to pull from? "))
+ # removes the r/ from the input
+ )
+ except ValueError:
+ subreddit = reddit.subreddit("askreddit")
+ print_substep("Subreddit not defined. Using AskReddit.")
+ else:
+ print_substep(f"Using subreddit: r/{getenv('SUBREDDIT')} from environment variable config")
+ subreddit_choice = getenv("SUBREDDIT")
+ if subreddit_choice.casefold().startswith("r/"): # removes the r/ from the input
+ subreddit_choice = subreddit_choice[2:]
+ subreddit = reddit.subreddit(
+ subreddit_choice
+ ) # Allows you to specify in .env. Done for automation purposes.
+
+ if POST_ID: # would only be called if there are multiple queued posts
+ submission = reddit.submission(id=POST_ID)
+ elif getenv("POST_ID") and len(getenv("POST_ID").split("+")) == 1:
+ submission = reddit.submission(id=getenv("POST_ID"))
else:
- # Otherwise, picks a random thread from the inserted subreddit
- if os.getenv("SUBREDDIT"):
- subreddit = reddit.subreddit(re.sub(r"r\/", "", os.getenv("SUBREDDIT")))
- else:
- # ! Prompt the user to enter a subreddit
- try:
- subreddit = reddit.subreddit(
- re.sub(
- r"r\/",
- "",
- input("What subreddit would you like to pull from? "),
- )
- )
- except ValueError:
- subreddit = reddit.subreddit("askreddit")
- print_substep("Subreddit not defined. Using AskReddit.")
threads = subreddit.hot(limit=25)
- submission = list(threads)[random.randrange(0, 25)]
-
- print_substep(f"Video will be: {submission.title}")
- print("Getting video comments...")
+ submission = get_subreddit_undone(threads, subreddit)
+ submission = check_done(submission) # double-checking
+ if submission is None:
+ return get_subreddit_threads(POST_ID) # submission already done. rerun
+ upvotes = submission.score
+ ratio = submission.upvote_ratio * 100
+ num_comments = submission.num_comments
- try:
- content["thread_url"] = submission.url
- content["thread_title"] = submission.title
- content["thread_post"] = submission.selftext
- content["comments"] = []
+ print_substep(f"Video will be: {submission.title} :thumbsup:", style="bold green")
+ print_substep(f"Thread has {upvotes} upvotes", style="bold blue")
+ print_substep(f"Thread has a upvote ratio of {ratio}%", style="bold blue")
+ print_substep(f"Thread has {num_comments} comments", style="bold blue")
- for top_level_comment in submission.comments:
- COMMENT_LENGTH_RANGE = [0, Infinity]
- if os.getenv("COMMENT_LENGTH_RANGE"):
- COMMENT_LENGTH_RANGE = [int(i) for i in os.getenv("COMMENT_LENGTH_RANGE").split(",")]
- if COMMENT_LENGTH_RANGE[0] <= len(top_level_comment.body) <= COMMENT_LENGTH_RANGE[1]:
- if not top_level_comment.stickied:
+ content["thread_url"] = f"https://reddit.com{submission.permalink}"
+ content["thread_title"] = submission.title
+ content["thread_post"] = submission.selftext
+ content["thread_id"] = submission.id
+ content["comments"] = []
+
+ for top_level_comment in submission.comments:
+ if isinstance(top_level_comment, MoreComments):
+ continue
+ if top_level_comment.body in ["[removed]", "[deleted]"]:
+ continue # # see https://github.com/JasonLovesDoggo/RedditVideoMakerBot/issues/78
+ if not top_level_comment.stickied:
+ if len(top_level_comment.body) <= int(getenv("MAX_COMMENT_LENGTH", "500")):
+ if (
+ top_level_comment.author is not None
+ ): # if errors occur with this change to if not.
content["comments"].append(
{
"comment_body": top_level_comment.body,
@@ -87,9 +102,5 @@ def get_subreddit_threads():
"comment_id": top_level_comment.id,
}
)
-
- except AttributeError:
- pass
- print_substep("Received AskReddit threads successfully.", style="bold green")
-
+ print_substep("Received subreddit threads Successfully.", style="bold green")
return content
diff --git a/requirements.txt b/requirements.txt
index fd28b7f..687f952 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,8 +1,12 @@
+boto3==1.24.12
+botocore==1.27.22
gTTS==2.2.4
moviepy==1.0.3
mutagen==1.45.1
-playwright==1.22.0
+playwright==1.23.0
praw==7.6.0
python-dotenv==0.20.0
+pytube==12.1.0
+requests==2.28.1
rich==12.4.4
-yt_dlp==2022.5.18
+translators==5.3.1
diff --git a/setup.py b/setup.py
deleted file mode 100755
index b09c30d..0000000
--- a/setup.py
+++ /dev/null
@@ -1,209 +0,0 @@
-#!/usr/bin/env python3
-# Setup Script for RedditVideoMakerBot
-
-
-# Imports
-import os
-import subprocess
-import re
-from utils.console import print_markdown
-from utils.console import print_step
-from rich.console import Console
-from utils.loader import Loader
-
-console = Console()
-
-
-def handle_input(
- message: str = "",
- check_type=False,
- match: str = "",
- err_message: str = "",
- nmin=None,
- nmax=None,
- oob_error="",
-):
- match = re.compile(match + "$")
- while True:
- user_input = input(message + "\n> ").strip()
- if re.match(match, user_input) is not None:
- if check_type is not False:
- try:
- user_input = check_type(user_input)
- if nmin is not None and user_input < nmin:
- console.log("[red]" + oob_error) # Input too low failstate
- continue
- if nmax is not None and user_input > nmax:
- console.log("[red]" + oob_error) # Input too high
- continue
- break # Successful type conversion and number in bounds
- except ValueError:
- console.log("[red]" + err_message) # Type conversion failed
- continue
- if (
- nmin is not None and len(user_input) < nmin
- ): # Check if string is long enough
- console.log("[red]" + oob_error)
- continue
- if (
- nmax is not None and len(user_input) > nmax
- ): # Check if string is not too long
- console.log("[red]" + oob_error)
- continue
- break
- console.log("[red]" + err_message)
-
- return user_input
-
-
-if os.path.isfile(".setup-done-before"):
- console.log(
- "[red]Setup was already completed! Please make sure you have to run this script again. If that is such, delete the file .setup-done-before"
- )
- exit()
-
-# These lines ensure the user:
-# - knows they are in setup mode
-# - knows that they are about to erase any other setup files/data.
-
-print_step("Setup Assistant")
-print_markdown(
- "### You're in the setup wizard. Ensure you're supposed to be here, then type yes to continue. If you're not sure, type no to quit."
-)
-
-
-# This Input is used to ensure the user is sure they want to continue.
-if input("Are you sure you want to continue? > ").strip().casefold() != "yes":
- console.print("[red]Exiting...")
- exit()
-# This code is inaccessible if the prior check fails, and thus an else statement is unnecessary
-
-
-# Again, let them know they are about to erase all other setup data.
-console.print(
- "[bold red] This will overwrite your current settings. Are you sure you want to continue? [bold green]yes/no"
-)
-
-
-if input("Are you sure you want to continue? > ").strip().casefold() != "yes":
- console.print("[red]Abort mission! Exiting...")
- exit()
-# This is once again inaccessible if the prior checks fail
-# Once they confirm, move on with the script.
-console.print("[bold green]Alright! Let's get started!")
-
-print("\n")
-console.log("Ensure you have the following ready to enter:")
-console.log("[bold green]Reddit Client ID")
-console.log("[bold green]Reddit Client Secret")
-console.log("[bold green]Reddit Username")
-console.log("[bold green]Reddit Password")
-console.log("[bold green]Reddit 2FA (yes or no)")
-console.log("[bold green]Opacity (range of 0-1, decimals are OK)")
-console.log("[bold green]Subreddit (without r/ or /r/)")
-console.log("[bold green]Theme (light or dark)")
-console.print(
- "[green]If you don't have these, please follow the instructions in the README.md file to set them up."
-)
-console.print(
- "[green]If you do have these, type yes to continue. If you dont, go ahead and grab those quickly and come back."
-)
-print()
-
-
-if input("Are you sure you have the credentials? > ").strip().casefold() != "yes":
- console.print("[red]I don't understand that.")
- console.print("[red]Exiting...")
- exit()
-
-
-console.print("[bold green]Alright! Let's get started!")
-
-# Begin the setup process.
-
-console.log("Enter your credentials now.")
-client_id = handle_input(
- "Client ID > ",
- False,
- "[-a-zA-Z0-9._~+/]+=*",
- "That is somehow not a correct ID, try again.",
- 12,
- 30,
- "The ID should be over 12 and under 30 characters, double check your input.",
-)
-client_sec = handle_input(
- "Client Secret > ",
- False,
- "[-a-zA-Z0-9._~+/]+=*",
- "That is somehow not a correct secret, try again.",
- 20,
- 40,
- "The secret should be over 20 and under 40 characters, double check your input.",
-)
-user = handle_input(
- "Username > ",
- False,
- r"[_0-9a-zA-Z]+",
- "That is not a valid user",
- 3,
- 20,
- "A username HAS to be between 3 and 20 characters",
-)
-passw = handle_input("Password > ", False, ".*", "", 8, None, "Password too short")
-twofactor = handle_input(
- "2fa Enabled? (yes/no) > ",
- False,
- r"(yes)|(no)",
- "You need to input either yes or no",
-)
-opacity = handle_input(
- "Opacity? (range of 0-1) > ",
- float,
- ".*",
- "You need to input a number between 0 and 1",
- 0,
- 1,
- "Your number is not between 0 and 1",
-)
-subreddit = handle_input(
- "Subreddit (without r/) > ",
- False,
- r"[_0-9a-zA-Z]+",
- "This subreddit cannot exist, make sure you typed it in correctly and removed the r/ (or /r/).",
- 3,
- 20,
- "A subreddit name HAS to be between 3 and 20 characters",
-)
-theme = handle_input(
- "Theme? (light or dark) > ",
- False,
- r"(light)|(dark)",
- "You need to input 'light' or 'dark'",
-)
-loader = Loader("Attempting to save your credentials...", "Done!").start()
-# you can also put a while loop here, e.g. while VideoIsBeingMade == True: ...
-console.log("Writing to the .env file...")
-with open(".env", "w") as f:
- f.write(
- f"""REDDIT_CLIENT_ID="{client_id}"
-REDDIT_CLIENT_SECRET="{client_sec}"
-REDDIT_USERNAME="{user}"
-REDDIT_PASSWORD="{passw}"
-REDDIT_2FA="{twofactor}"
-THEME="{theme}"
-SUBREDDIT="{subreddit}"
-OPACITY={opacity}
-"""
- )
-
-with open(".setup-done-before", "w") as f:
- f.write(
- "This file blocks the setup assistant from running again. Delete this file to run setup again."
- )
-
-loader.stop()
-
-console.log("[bold green]Setup Complete! Returning...")
-
-# Post-Setup: send message and try to run main.py again.
-subprocess.call("python3 main.py", shell=True)
diff --git a/utils/__init__.py b/utils/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/utils/checker.py b/utils/checker.py
new file mode 100755
index 0000000..791a376
--- /dev/null
+++ b/utils/checker.py
@@ -0,0 +1,193 @@
+#!/usr/bin/env python
+import os
+from rich.console import Console
+from rich.table import Table
+from rich import box
+import re
+import dotenv
+from utils.console import handle_input
+
+console = Console()
+
+
+def check_env() -> bool:
+ """Checks to see what's been put in .env
+
+ Returns:
+ bool: Whether or not everything was put in properly
+ """
+ if not os.path.exists(".env.template"):
+ console.print("[red]Couldn't find .env.template. Unable to check variables.")
+ return True
+ if not os.path.exists(".env"):
+ console.print("[red]Couldn't find the .env file, creating one now.")
+ with open(".env", "x", encoding="utf-8") as file:
+ file.write("")
+ success = True
+ with open(".env.template", "r", encoding="utf-8") as template:
+ # req_envs = [env.split("=")[0] for env in template.readlines() if "=" in env]
+ matching = {}
+ explanations = {}
+ bounds = {}
+ types = {}
+ oob_errors = {}
+ examples = {}
+ req_envs = []
+ var_optional = False
+ for line in template.readlines():
+ if line.startswith("#") is not True and "=" in line and var_optional is not True:
+ req_envs.append(line.split("=")[0])
+ if "#" in line:
+ examples[line.split("=")[0]] = "#".join(line.split("#")[1:]).strip()
+ elif "#OPTIONAL" in line:
+ var_optional = True
+ elif line.startswith("#MATCH_REGEX "):
+ matching[req_envs[-1]] = line.removeprefix("#MATCH_REGEX ")[:-1]
+ var_optional = False
+ elif line.startswith("#OOB_ERROR "):
+ oob_errors[req_envs[-1]] = line.removeprefix("#OOB_ERROR ")[:-1]
+ var_optional = False
+ elif line.startswith("#RANGE "):
+ bounds[req_envs[-1]] = tuple(
+ map(
+ lambda x: float(x) if x != "None" else None,
+ line.removeprefix("#RANGE ")[:-1].split(":"),
+ )
+ )
+ var_optional = False
+ elif line.startswith("#MATCH_TYPE "):
+ types[req_envs[-1]] = eval(line.removeprefix("#MATCH_TYPE ")[:-1].split()[0])
+ var_optional = False
+ elif line.startswith("#EXPLANATION "):
+ explanations[req_envs[-1]] = line.removeprefix("#EXPLANATION ")[:-1]
+ var_optional = False
+ else:
+ var_optional = False
+ missing = set()
+ incorrect = set()
+ dotenv.load_dotenv()
+ for env in req_envs:
+ value = os.getenv(env)
+ if value is None:
+ missing.add(env)
+ continue
+ if env in matching.keys():
+ re.match(matching[env], value) is None and incorrect.add(env)
+ if env in bounds.keys() and env not in types.keys():
+ len(value) >= bounds[env][0] or (
+ len(bounds[env]) > 1 and bounds[env][1] >= len(value)
+ ) or incorrect.add(env)
+ continue
+ if env in types.keys():
+ try:
+ temp = types[env](value)
+ if env in bounds.keys():
+ (bounds[env][0] <= temp or incorrect.add(env)) and len(bounds[env]) > 1 and (
+ bounds[env][1] >= temp or incorrect.add(env)
+ )
+ except ValueError:
+ incorrect.add(env)
+
+ if len(missing):
+ table = Table(
+ title="Missing variables",
+ highlight=True,
+ show_lines=True,
+ box=box.ROUNDED,
+ border_style="#414868",
+ header_style="#C0CAF5 bold",
+ title_justify="left",
+ title_style="#C0CAF5 bold",
+ )
+ table.add_column("Variable", justify="left", style="#7AA2F7 bold", no_wrap=True)
+ table.add_column("Explanation", justify="left", style="#BB9AF7", no_wrap=False)
+ table.add_column("Example", justify="center", style="#F7768E", no_wrap=True)
+ table.add_column("Min", justify="right", style="#F7768E", no_wrap=True)
+ table.add_column("Max", justify="left", style="#F7768E", no_wrap=True)
+ for env in missing:
+ table.add_row(
+ env,
+ explanations[env] if env in explanations.keys() else "No explanation given",
+ examples[env] if env in examples.keys() else "",
+ str(bounds[env][0]) if env in bounds.keys() and bounds[env][1] is not None else "",
+ str(bounds[env][1])
+ if env in bounds.keys() and len(bounds[env]) > 1 and bounds[env][1] is not None
+ else "",
+ )
+ console.print(table)
+ success = False
+ if len(incorrect):
+ table = Table(
+ title="Incorrect variables",
+ highlight=True,
+ show_lines=True,
+ box=box.ROUNDED,
+ border_style="#414868",
+ header_style="#C0CAF5 bold",
+ title_justify="left",
+ title_style="#C0CAF5 bold",
+ )
+ table.add_column("Variable", justify="left", style="#7AA2F7 bold", no_wrap=True)
+ table.add_column("Current value", justify="left", style="#F7768E", no_wrap=False)
+ table.add_column("Explanation", justify="left", style="#BB9AF7", no_wrap=False)
+ table.add_column("Example", justify="center", style="#F7768E", no_wrap=True)
+ table.add_column("Min", justify="right", style="#F7768E", no_wrap=True)
+ table.add_column("Max", justify="left", style="#F7768E", no_wrap=True)
+ for env in incorrect:
+ table.add_row(
+ env,
+ os.getenv(env),
+ explanations[env] if env in explanations.keys() else "No explanation given",
+ str(types[env].__name__) if env in types.keys() else "str",
+ str(bounds[env][0]) if env in bounds.keys() else "None",
+ str(bounds[env][1]) if env in bounds.keys() and len(bounds[env]) > 1 else "None",
+ )
+ missing.add(env)
+ console.print(table)
+ success = False
+ if success is True:
+ return True
+ console.print(
+ "[green]Do you want to automatically overwrite incorrect variables and add the missing variables? (y/n)"
+ )
+ if not input().casefold().startswith("y"):
+ console.print("[red]Aborting: Unresolved missing variables")
+ return False
+ if len(incorrect):
+ with open(".env", "r+", encoding="utf-8") as env_file:
+ lines = []
+ for line in env_file.readlines():
+ line.split("=")[0].strip() not in incorrect and lines.append(line)
+ env_file.seek(0)
+ env_file.write("\n".join(lines))
+ env_file.truncate()
+ console.print("[green]Successfully removed incorrectly set variables from .env")
+ with open(".env", "a", encoding="utf-8") as env_file:
+ for env in missing:
+ env_file.write(
+ env
+ + "="
+ + ('"' if env not in types.keys() else "")
+ + str(
+ handle_input(
+ "[#F7768E bold]" + env + "[#C0CAF5 bold]=",
+ types[env] if env in types.keys() else False,
+ matching[env] if env in matching.keys() else ".*",
+ explanations[env]
+ if env in explanations.keys()
+ else "Incorrect input. Try again.",
+ bounds[env][0] if env in bounds.keys() else None,
+ bounds[env][1] if env in bounds.keys() and len(bounds[env]) > 1 else None,
+ oob_errors[env] if env in oob_errors.keys() else "Input too long/short.",
+ extra_info="[#C0CAF5 bold]âŽļ "
+ + (explanations[env] if env in explanations.keys() else "No info available"),
+ )
+ )
+ + ('"' if env not in types.keys() else "")
+ + "\n"
+ )
+ return True
+
+
+if __name__ == "__main__":
+ check_env()
diff --git a/utils/cleanup.py b/utils/cleanup.py
new file mode 100644
index 0000000..ef4fc44
--- /dev/null
+++ b/utils/cleanup.py
@@ -0,0 +1,27 @@
+import os
+from os.path import exists
+
+
+def cleanup() -> int:
+ """Deletes all temporary assets in assets/temp
+
+ Returns:
+ int: How many files were deleted
+ """
+ if exists("./assets/temp"):
+ count = 0
+ files = [f for f in os.listdir(".") if f.endswith(".mp4") and "temp" in f.lower()]
+ count += len(files)
+ for f in files:
+ os.remove(f)
+ try:
+ for file in os.listdir("./assets/temp/mp4"):
+ count += 1
+ os.remove("./assets/temp/mp4/" + file)
+ except FileNotFoundError:
+ pass
+ for file in os.listdir("./assets/temp/mp3"):
+ count += 1
+ os.remove("./assets/temp/mp3/" + file)
+ return count
+ return 0
diff --git a/utils/config.py b/utils/config.py
new file mode 100644
index 0000000..29cbb79
--- /dev/null
+++ b/utils/config.py
@@ -0,0 +1,46 @@
+# write a class that takes .env file and parses it into a dictionary
+from dotenv import dotenv_values
+
+DEFAULTS = {
+ "SUBREDDIT": "AskReddit",
+ "ALLOW_NSFW": "False",
+ "POST_ID": "",
+ "THEME": "DARK",
+ "REDDIT_2FA": "no",
+ "TIMES_TO_RUN": "",
+ "MAX_COMMENT_LENGTH": "500",
+ "OPACITY": "1",
+ "VOICE": "en_us_001",
+ "STORYMODE": "False",
+}
+
+
+class Config:
+ def __init__(self):
+ self.raw = dotenv_values("../.env")
+ self.load_attrs()
+
+ def __getattr__(self, attr): # code completion for attributes fix.
+ return getattr(self, attr)
+
+ def load_attrs(self):
+ for key, value in self.raw.items():
+ self.add_attr(key, value)
+
+ def add_attr(self, key, value):
+ if value is None or value == "":
+ setattr(self, key, DEFAULTS[key])
+ else:
+ setattr(self, key, str(value))
+
+
+config = Config()
+
+print(config.SUBREDDIT)
+# def temp():
+# root = ''
+# if isinstance(root, praw.models.Submission):
+# root_type = 'submission'
+# elif isinstance(root, praw.models.Comment):
+# root_type = 'comment'
+#
diff --git a/utils/console.py b/utils/console.py
index 11ee429..5b91fef 100644
--- a/utils/console.py
+++ b/utils/console.py
@@ -4,6 +4,8 @@ from rich.markdown import Markdown
from rich.padding import Padding
from rich.panel import Panel
from rich.text import Text
+from rich.columns import Columns
+import re
console = Console()
@@ -25,3 +27,50 @@ def print_step(text):
def print_substep(text, style=""):
"""Prints a rich info message without the panelling."""
console.print(text, style=style)
+
+
+def print_table(items):
+ """Prints items in a table."""
+
+ console.print(Columns([Panel(f"[yellow]{item}", expand=True) for item in items]))
+
+
+def handle_input(
+ message: str = "",
+ check_type=False,
+ match: str = "",
+ err_message: str = "",
+ nmin=None,
+ nmax=None,
+ oob_error="",
+ extra_info="",
+):
+ match = re.compile(match + "$")
+ console.print(extra_info, no_wrap=True)
+ while True:
+ console.print(message, end="")
+ user_input = input("").strip()
+ if re.match(match, user_input) is not None:
+ if check_type is not False:
+ try:
+ user_input = check_type(user_input) # this line is fine
+ if nmin is not None and user_input < nmin:
+ console.print("[red]" + oob_error) # Input too low failstate
+ continue
+ if nmax is not None and user_input > nmax:
+ console.print("[red]" + oob_error) # Input too high
+ continue
+ break # Successful type conversion and number in bounds
+ except ValueError:
+ console.print("[red]" + err_message) # Type conversion failed
+ continue
+ if nmin is not None and len(user_input) < nmin: # Check if string is long enough
+ console.print("[red]" + oob_error)
+ continue
+ if nmax is not None and len(user_input) > nmax: # Check if string is not too long
+ console.print("[red]" + oob_error)
+ continue
+ break
+ console.print("[red]" + err_message)
+
+ return user_input
diff --git a/utils/loader.py b/utils/loader.py
index 46c40fe..b9dc276 100644
--- a/utils/loader.py
+++ b/utils/loader.py
@@ -1,4 +1,3 @@
-
# Okay, have to admit. This code is from StackOverflow. It's so efficient, that it's probably the best way to do it.
# Although, it is edited to use less threads.
@@ -15,9 +14,9 @@ class Loader:
A loader-like context manager
Args:
- desc (str, optional): The loader's description. Defaults to "Loading...".
- end (str, optional): Final print. Defaults to "Done!".
- timeout (float, optional): Sleep time between prints. Defaults to 0.1.
+ desc (str, optional): The loader's description. Defaults to "Loading...".
+ end (str, optional): Final print. Defaults to "Done!".
+ timeout (float, optional): Sleep time between prints. Defaults to 0.1.
"""
self.desc = desc
self.end = end
diff --git a/utils/subreddit.py b/utils/subreddit.py
new file mode 100644
index 0000000..f6ca686
--- /dev/null
+++ b/utils/subreddit.py
@@ -0,0 +1,54 @@
+import json
+from os import getenv
+from utils.console import print_substep
+
+
+def get_subreddit_undone(submissions: list, subreddit):
+ """_summary_
+
+ Args:
+ submissions (list): List of posts that are going to potentially be generated into a video
+ subreddit (praw.Reddit.SubredditHelper): Chosen subreddit
+
+ Returns:
+ Any: The submission that has not been done
+ """
+ # recursively checks if the top submission in the list was already done.
+
+ with open("./video_creation/data/videos.json", "r", encoding="utf-8") as done_vids_raw:
+ done_videos = json.load(done_vids_raw)
+ for submission in submissions:
+ if already_done(done_videos, submission):
+ continue
+ if submission.over_18:
+ try:
+ if getenv("ALLOW_NSFW").casefold() == "false":
+ print_substep("NSFW Post Detected. Skipping...")
+ continue
+ except AttributeError:
+ print_substep("NSFW settings not defined. Skipping NSFW post...")
+ if submission.stickied:
+ print_substep("This post was pinned by moderators. Skipping...")
+ continue
+ return submission
+ print("all submissions have been done going by top submission order")
+ return get_subreddit_undone(
+ subreddit.top(time_filter="hour"), subreddit
+ ) # all of the videos in hot have already been done
+
+
+def already_done(done_videos: list, submission) -> bool:
+ """Checks to see if the given submission is in the list of videos
+
+ Args:
+ done_videos (list): Finished videos
+ submission (Any): The submission
+
+ Returns:
+ Boolean: Whether the video was found in the list
+ """
+
+ for video in done_videos:
+ if video["id"] == str(submission):
+ return True
+ return False
diff --git a/utils/videos.py b/utils/videos.py
new file mode 100755
index 0000000..07659f6
--- /dev/null
+++ b/utils/videos.py
@@ -0,0 +1,60 @@
+import json
+import os
+import time
+from os import getenv
+from typing import Dict
+
+from praw.models import Submission
+
+from utils.console import print_step
+
+
+def check_done(
+ redditobj: Submission,
+) -> Submission:
+ # don't set this to be run anyplace that isn't subreddit.py bc of inspect stack
+ """Checks if the chosen post has already been generated
+
+ Args:
+ redditobj (Dict[str]): Reddit object gotten from reddit/subreddit.py
+
+ Returns:
+ Dict[str]|None: Reddit object in args
+ """
+ with open("./video_creation/data/videos.json", "r", encoding="utf-8") as done_vids_raw:
+ done_videos = json.load(done_vids_raw)
+ for video in done_videos:
+ if video["id"] == str(redditobj):
+ if getenv("POST_ID"):
+ print_step(
+ "You already have done this video but since it was declared specifically in the .env file the program will continue"
+ )
+ return redditobj
+ print_step("Getting new post as the current one has already been done")
+ return None
+ return redditobj
+
+
+def save_data(filename: str, reddit_title: str, reddit_id: str):
+ """Saves the videos that have already been generated to a JSON file in video_creation/data/videos.json
+
+ Args:
+ filename (str): The finished video title name
+ @param filename:
+ @param reddit_id:
+ @param reddit_title:
+ """
+ with open("./video_creation/data/videos.json", "r+", encoding="utf-8") as raw_vids:
+ done_vids = json.load(raw_vids)
+ if reddit_id in [video["id"] for video in done_vids]:
+ return # video already done but was specified to continue anyway in the .env file
+ payload = {
+ "id": reddit_id,
+ "time": str(int(time.time())),
+ "background_credit": str(os.getenv("background_credit")),
+ "reddit_title": reddit_title,
+ "filename": filename,
+ }
+ done_vids.append(payload)
+ raw_vids.seek(0)
+ json.dump(done_vids, raw_vids, ensure_ascii=False, indent=4)
diff --git a/utils/voice.py b/utils/voice.py
new file mode 100644
index 0000000..c4f27bf
--- /dev/null
+++ b/utils/voice.py
@@ -0,0 +1,27 @@
+import re
+
+
+def sanitize_text(text: str) -> str:
+ r"""Sanitizes the text for tts.
+ What gets removed:
+ - following characters`^_~@!&;#:-%âââ"%*/{}[]()\|<>?=+`
+ - any http or https links
+
+ Args:
+ text (str): Text to be sanitized
+
+ Returns:
+ str: Sanitized text
+ """
+
+ # remove any urls from the text
+ regex_urls = r"((http|https)\:\/\/)?[a-zA-Z0-9\.\/\?\:@\-_=#]+\.([a-zA-Z]){2,6}([a-zA-Z0-9\.\&\/\?\:@\-_=#])*"
+
+ result = re.sub(regex_urls, " ", text)
+
+ # note: not removing apostrophes
+ regex_expr = r"\s['|â]|['|â]\s|[\^_~@!&;#:\-%âââ\"%\*/{}\[\]\(\)\\|<>=+]"
+ result = re.sub(regex_expr, " ", result)
+ result = result.replace("+", "plus").replace("&", "and")
+ # remove extra whitespace
+ return " ".join(result.split())
diff --git a/video_creation/__init__.py b/video_creation/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/video_creation/background.py b/video_creation/background.py
index ff88346..2654499 100644
--- a/video_creation/background.py
+++ b/video_creation/background.py
@@ -1,75 +1,83 @@
-#!/usr/bin/env python3
+import random
+from os import listdir, environ
+from pathlib import Path
from random import randrange
+from typing import Tuple
-from yt_dlp import YoutubeDL
-
-from pathlib import Path
-from moviepy.video.io.ffmpeg_tools import ffmpeg_extract_subclip
from moviepy.editor import VideoFileClip
+from moviepy.video.io.ffmpeg_tools import ffmpeg_extract_subclip
+from pytube import YouTube
+
from utils.console import print_step, print_substep
-import datetime
+def get_start_and_end_times(video_length: int, length_of_clip: int) -> Tuple[int, int]:
+ """Generates a random interval of time to be used as the background of the video.
-def get_start_and_end_times(video_length, length_of_clip):
+ Args:
+ video_length (int): Length of the video
+ length_of_clip (int): Length of the video to be used as the background
+ Returns:
+ tuple[int,int]: Start and end time of the randomized interval
+ """
random_time = randrange(180, int(length_of_clip) - int(video_length))
return random_time, random_time + video_length
-def download_background(video_length):
-
- """Downloads the background video from youtube.
- Shoutout to: bbswitzer (https://www.youtube.com/watch?v=n_Dv4JMiwK8)
- """
-
- print_substep("\nPut the URL of the video you want in the background.\nThe default video is a Minecraft parkour video.\n"
- "Leave the input field blank to use the default.")
- print_substep(f"Make sure the video is longer than {str(datetime.timedelta(seconds=round(video_length + 180)))}!\n", style="red")
-
- inp = input("URL: ")
-
- if not inp:
- vidurl = "https://www.youtube.com/watch?v=n_Dv4JMiwK8"
- else:
- vidurl = inp
-
- vidpath = vidurl.split("v=")[1]
-
- if not Path(f"assets/mp4/{vidpath}.mp4").is_file():
+def download_background():
+ """Downloads the backgrounds/s video from YouTube."""
+ Path("./assets/backgrounds/").mkdir(parents=True, exist_ok=True)
+ background_options = [ # uri , filename , credit
+ ("https://www.youtube.com/watch?v=n_Dv4JMiwK8", "parkour.mp4", "bbswitzer"),
+ # (
+ # "https://www.youtube.com/watch?v=2X9QGY__0II",
+ # "rocket_league.mp4",
+ # "Orbital Gameplay",
+ # ),
+ ]
+ # note: make sure the file name doesn't include an - in it
+ if not len(listdir("./assets/backgrounds")) >= len(
+ background_options
+ ): # if there are any background videos not installed
print_step(
- "We need to download the background video. This may be fairly large but it's only done once per background."
+ "We need to download the backgrounds videos. they are fairly large but it's only done once. đ"
)
+ print_substep("Downloading the backgrounds videos... please be patient đ ")
+ for uri, filename, credit in background_options:
+ if Path(f"assets/backgrounds/{credit}-{filename}").is_file():
+ continue # adds check to see if file exists before downloading
+ print_substep(f"Downloading {filename} from {uri}")
+ YouTube(uri).streams.filter(res="1080p").first().download(
+ "assets/backgrounds", filename=f"{credit}-{filename}"
+ )
- print_substep("Downloading the background video... please be patient.")
+ print_substep("Background videos downloaded successfully! đ", style="bold green")
- ydl_opts = {
- "outtmpl": f"assets/mp4/{vidpath}.mp4",
- "merge_output_format": "mp4",
- }
- with YoutubeDL(ydl_opts) as ydl:
- ydl.download(vidurl)
+def chop_background_video(video_length: int):
+ """Generates the background footage to be used in the video and writes it to assets/temp/background.mp4
- print_substep("Background video downloaded successfully!", style="bold green")
-
- return vidpath
+ Args:
+ video_length (int): Length of the clip where the background footage is to be taken out of
+ """
+ print_step("Finding a spot in the backgrounds video to chop...âī¸")
+ choice = random.choice(listdir("assets/backgrounds"))
+ environ["background_credit"] = choice.split("-")[0]
+ background = VideoFileClip(f"assets/backgrounds/{choice}")
-def chop_background_video(video_length, vidpath):
- print_step("Finding a spot in the background video to chop...")
- background = VideoFileClip(f"assets/mp4/{vidpath}.mp4")
- if background.duration < video_length + 180:
- print_substep("This video is too short.", style="red")
- noerror = False
- return noerror
start_time, end_time = get_start_and_end_times(video_length, background.duration)
- ffmpeg_extract_subclip(
- f"assets/mp4/{vidpath}.mp4",
- start_time,
- end_time,
- targetname="assets/mp4/clip.mp4",
- )
+ try:
+ ffmpeg_extract_subclip(
+ f"assets/backgrounds/{choice}",
+ start_time,
+ end_time,
+ targetname="assets/temp/background.mp4",
+ )
+ except (OSError, IOError): # ffmpeg issue see #348
+ print_substep("FFMPEG issue. Trying again...")
+ with VideoFileClip(f"assets/backgrounds/{choice}") as video:
+ new = video.subclip(start_time, end_time)
+ new.write_videofile("assets/temp/background.mp4")
print_substep("Background video chopped successfully!", style="bold green")
- noerror = True
- return noerror
diff --git a/video_creation/cookies.json b/video_creation/cookies.json
deleted file mode 100644
index 2e4e116..0000000
--- a/video_creation/cookies.json
+++ /dev/null
@@ -1,8 +0,0 @@
-[
- {
- "name": "USER",
- "value": "eyJwcmVmcyI6eyJ0b3BDb250ZW50RGlzbWlzc2FsVGltZSI6MCwiZ2xvYmFsVGhlbWUiOiJSRURESVQiLCJuaWdodG1vZGUiOnRydWUsImNvbGxhcHNlZFRyYXlTZWN0aW9ucyI6eyJmYXZvcml0ZXMiOmZhbHNlLCJtdWx0aXMiOmZhbHNlLCJtb2RlcmF0aW5nIjpmYWxzZSwic3Vic2NyaXB0aW9ucyI6ZmFsc2UsInByb2ZpbGVzIjpmYWxzZX0sInRvcENvbnRlbnRUaW1lc0Rpc21pc3NlZCI6MH19",
- "domain": ".reddit.com",
- "path": "/"
- }
-]
diff --git a/video_creation/data/cookie-dark-mode.json b/video_creation/data/cookie-dark-mode.json
new file mode 100644
index 0000000..774f4cc
--- /dev/null
+++ b/video_creation/data/cookie-dark-mode.json
@@ -0,0 +1,14 @@
+[
+ {
+ "name": "USER",
+ "value": "eyJwcmVmcyI6eyJ0b3BDb250ZW50RGlzbWlzc2FsVGltZSI6MCwiZ2xvYmFsVGhlbWUiOiJSRURESVQiLCJuaWdodG1vZGUiOnRydWUsImNvbGxhcHNlZFRyYXlTZWN0aW9ucyI6eyJmYXZvcml0ZXMiOmZhbHNlLCJtdWx0aXMiOmZhbHNlLCJtb2RlcmF0aW5nIjpmYWxzZSwic3Vic2NyaXB0aW9ucyI6ZmFsc2UsInByb2ZpbGVzIjpmYWxzZX0sInRvcENvbnRlbnRUaW1lc0Rpc21pc3NlZCI6MH19",
+ "domain": ".reddit.com",
+ "path": "/"
+ },
+ {
+ "name": "eu_cookie",
+ "value": "{%22opted%22:true%2C%22nonessential%22:false}",
+ "domain": ".reddit.com",
+ "path": "/"
+ }
+]
diff --git a/video_creation/data/cookie-light-mode.json b/video_creation/data/cookie-light-mode.json
new file mode 100644
index 0000000..048a3e3
--- /dev/null
+++ b/video_creation/data/cookie-light-mode.json
@@ -0,0 +1,8 @@
+[
+ {
+ "name": "eu_cookie",
+ "value": "{%22opted%22:true%2C%22nonessential%22:false}",
+ "domain": ".reddit.com",
+ "path": "/"
+ }
+]
diff --git a/video_creation/data/videos.json b/video_creation/data/videos.json
new file mode 100644
index 0000000..fe51488
--- /dev/null
+++ b/video_creation/data/videos.json
@@ -0,0 +1 @@
+[]
diff --git a/video_creation/final_video.py b/video_creation/final_video.py
old mode 100644
new mode 100755
index f2acf74..d706361
--- a/video_creation/final_video.py
+++ b/video_creation/final_video.py
@@ -1,4 +1,10 @@
#!/usr/bin/env python3
+import multiprocessing
+import os
+import re
+from os.path import exists
+from typing import Dict
+
from moviepy.editor import (
VideoFileClip,
AudioFileClip,
@@ -8,11 +14,14 @@ from moviepy.editor import (
CompositeAudioClip,
CompositeVideoClip,
)
-import reddit.subreddit
-import re
+from moviepy.video.io import ffmpeg_tools
+from rich.console import Console
+
+from utils.cleanup import cleanup
from utils.console import print_step, print_substep
-from dotenv import load_dotenv
-import os
+from utils.videos import save_data
+
+console = Console()
W, H = 1080, 1920
@@ -29,78 +38,97 @@ def name_normalize(
return name
-def make_final_video(number_of_clips):
-
- # Calls opacity from the .env
- load_dotenv()
- opacity = os.getenv("OPACITY")
-
- print_step("Creating the final video...")
+def make_final_video(number_of_clips: int, length: int, reddit_obj: dict):
+ """Gathers audio clips, gathers all screenshots, stitches them together and saves the final video to assets/temp
+ Args:
+ number_of_clips (int): Index to end at when going through the screenshots
+ length (int): Length of the video
+ reddit_obj (dict): The reddit object that contains the posts to read.
+ """
+ print_step("Creating the final video đĨ")
VideoFileClip.reW = lambda clip: clip.resize(width=W)
VideoFileClip.reH = lambda clip: clip.resize(width=H)
-
+ opacity = os.getenv("OPACITY")
background_clip = (
- VideoFileClip("assets/mp4/clip.mp4")
+ VideoFileClip("assets/temp/background.mp4")
.without_audio()
.resize(height=H)
.crop(x1=1166.6, y1=0, x2=2246.6, y2=1920)
)
# Gather all audio clips
- audio_clips = []
- for i in range(0, number_of_clips):
- audio_clips.append(AudioFileClip(f"assets/mp3/{i}.mp3"))
- audio_clips.insert(0, AudioFileClip("assets/mp3/title.mp3"))
- try:
- audio_clips.insert(1, AudioFileClip("assets/mp3/posttext.mp3"))
- except:
- OSError()
+ audio_clips = [AudioFileClip(f"assets/temp/mp3/{i}.mp3") for i in range(number_of_clips)]
+ audio_clips.insert(0, AudioFileClip("assets/temp/mp3/title.mp3"))
audio_concat = concatenate_audioclips(audio_clips)
audio_composite = CompositeAudioClip([audio_concat])
- # Gather all images
+ console.log(f"[bold green] Video Will Be: {length} Seconds Long")
+ # add title to video
image_clips = []
+ # Gather all images
+ new_opacity = 1 if opacity is None or float(opacity) >= 1 else float(opacity)
+
+ image_clips.insert(
+ 0,
+ ImageClip("assets/temp/png/title.png")
+ .set_duration(audio_clips[0].duration)
+ .set_position("center")
+ .resize(width=W - 100)
+ .set_opacity(new_opacity)
+ )
+
for i in range(0, number_of_clips):
image_clips.append(
- ImageClip(f"assets/png/comment_{i}.png")
+ ImageClip(f"assets/temp/png/comment_{i}.png")
.set_duration(audio_clips[i + 1].duration)
.set_position("center")
.resize(width=W - 100)
- .set_opacity(float(opacity)),
+ .set_opacity(new_opacity)
)
- if os.path.exists("assets/mp3/posttext.mp3"):
- image_clips.insert(
- 0,
- ImageClip("assets/png/title.png")
- .set_duration(audio_clips[0].duration + audio_clips[1].duration)
- .set_position("center")
- .resize(width=W - 100)
- .set_opacity(float(opacity)),
- )
- else:
- image_clips.insert(
- 0,
- ImageClip("assets/png/title.png")
- .set_duration(audio_clips[0].duration)
- .set_position("center")
- .resize(width=W - 100)
- .set_opacity(float(opacity)),
- )
- image_concat = concatenate_videoclips(image_clips).set_position(
- ("center", "center")
- )
+
+ # if os.path.exists("assets/mp3/posttext.mp3"):
+ # image_clips.insert(
+ # 0,
+ # ImageClip("assets/png/title.png")
+ # .set_duration(audio_clips[0].duration + audio_clips[1].duration)
+ # .set_position("center")
+ # .resize(width=W - 100)
+ # .set_opacity(float(opacity)),
+ # )
+ # else:
+ image_concat = concatenate_videoclips(image_clips).set_position(("center", "center"))
image_concat.audio = audio_composite
final = CompositeVideoClip([background_clip, image_concat])
- final_video_path = "assets/"
- if os.getenv("FINAL_VIDEO_PATH"):
- final_video_path = os.getenv("FINAL_VIDEO_PATH")
- filename = final_video_path + name_normalize(reddit.subreddit.submission.title) + ".mp4"
- try:
- final.write_videofile(filename, fps=30, audio_codec="aac", audio_bitrate="192k")
- except:
- print_substep("Something's wrong with the path you inserted, the video will be saved in the default path (assets/)", style="bold red")
- filename = (re.sub('[?\"%*:|<>]', '', ("assets/" + reddit.subreddit.submission.title + ".mp4")))
- final.write_videofile(filename, fps=30, audio_codec="aac", audio_bitrate="192k")
- for i in range(0, number_of_clips):
- pass
+ title = re.sub(r"[^\w\s-]", "", reddit_obj["thread_title"])
+ idx = re.sub(r"[^\w\s-]", "", reddit_obj["thread_id"])
+ filename = f"{name_normalize(title)}.mp4"
+ subreddit = os.getenv("SUBREDDIT")
+
+ save_data(filename, title, idx)
+
+ if not exists(f"./results/{subreddit}"):
+ print_substep("The results folder didn't exist so I made it")
+ os.makedirs(f"./results/{subreddit}")
+
+ final.write_videofile(
+ "assets/temp/temp.mp4",
+ fps=30,
+ audio_codec="aac",
+ audio_bitrate="192k",
+ verbose=False,
+ threads=multiprocessing.cpu_count(),
+ )
+ ffmpeg_tools.ffmpeg_extract_subclip(
+ "assets/temp/temp.mp4", 0, final.duration, targetname=f"results/{subreddit}/{filename}"
+ )
+ # os.remove("assets/temp/temp.mp4")
+
+ print_step("Removing temporary files đ")
+ cleanups = cleanup()
+ print_substep(f"Removed {cleanups} temporary files đ")
+ print_substep("See result in the results folder!")
+
+ print_step(
+ f'Reddit title: {reddit_obj["thread_title"]} \n Background Credit: {os.getenv("background_credit")}'
+ )
diff --git a/video_creation/screenshot_downloader.py b/video_creation/screenshot_downloader.py
index 5f884f0..e8afc44 100644
--- a/video_creation/screenshot_downloader.py
+++ b/video_creation/screenshot_downloader.py
@@ -1,22 +1,33 @@
-#!/usr/bin/env python3
-from playwright.sync_api import sync_playwright, ViewportSize
+import json
+import os
+from os import getenv
from pathlib import Path
+from typing import Dict
+
+from playwright.async_api import async_playwright # pylint: disable=unused-import
+
+# do not remove the above line
+
+from playwright.sync_api import sync_playwright, ViewportSize
from rich.progress import track
+import translators as ts
+
from utils.console import print_step, print_substep
-import json
+storymode = False
-def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
- """Downloads screenshots of reddit posts as they are seen on the web.
+
+def download_screenshots_of_reddit_posts(reddit_object: dict, screenshot_num: int):
+ """Downloads screenshots of reddit posts as seen on the web. Downloads to assets/temp/png
Args:
- reddit_object: The Reddit Object you received in askreddit.py
- screenshot_num: The number of screenshots you want to download.
+ reddit_object (Dict[str]): Reddit object received from reddit/subreddit.py
+ screenshot_num (int): Number of screenshots to downlaod
"""
print_step("Downloading screenshots of reddit posts...")
# ! Make sure the reddit screenshots folder exists
- Path("assets/png").mkdir(parents=True, exist_ok=True)
+ Path("assets/temp/png").mkdir(parents=True, exist_ok=True)
with sync_playwright() as p:
print_substep("Launching Headless Browser...")
@@ -24,43 +35,70 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
browser = p.chromium.launch()
context = browser.new_context()
- try:
- if theme.casefold() == "dark":
- cookie_file = open('video_creation/cookies.json')
- cookies = json.load(cookie_file)
- context.add_cookies(cookies)
- except AttributeError:
- pass
-
+ if getenv("THEME").upper() == "DARK":
+ cookie_file = open("./video_creation/data/cookie-dark-mode.json", encoding="utf-8")
+ else:
+ cookie_file = open("./video_creation/data/cookie-light-mode.json", encoding="utf-8")
+ cookies = json.load(cookie_file)
+ context.add_cookies(cookies) # load preference cookies
# Get the thread screenshot
page = context.new_page()
- page.goto(reddit_object["thread_url"])
+ page.goto(reddit_object["thread_url"], timeout=0)
page.set_viewport_size(ViewportSize(width=1920, height=1080))
if page.locator('[data-testid="content-gate"]').is_visible():
# This means the post is NSFW and requires to click the proceed button.
print_substep("Post is NSFW. You are spicy...")
page.locator('[data-testid="content-gate"] button').click()
- page.locator('[data-click-id="text"] button').click() # Remove "Click to see nsfw" Button in Screenshot
+ page.locator(
+ '[data-click-id="text"] button'
+ ).click() # Remove "Click to see nsfw" Button in Screenshot
- page.locator('[data-test-id="post-content"]').screenshot(
- path="assets/png/title.png"
- )
+ # translate code
- for idx, comment in track(
- enumerate(reddit_object["comments"]), "Downloading screenshots..."
- ):
+ if getenv("POSTLANG"):
+ print_substep("Translating post...")
+ texts_in_tl = ts.google(reddit_object["thread_title"], to_language=os.getenv("POSTLANG"))
- # Stop if we have reached the screenshot_num
- if idx >= screenshot_num:
- break
+ page.evaluate(
+ "tl_content => document.querySelector('[data-test-id=\"post-content\"] > div:nth-child(3) > div > div').textContent = tl_content",
+ texts_in_tl,
+ )
+ else:
+ print_substep("Skipping translation...")
- if page.locator('[data-testid="content-gate"]').is_visible():
- page.locator('[data-testid="content-gate"] button').click()
+ page.locator('[data-test-id="post-content"]').screenshot(path="assets/temp/png/title.png")
- page.goto(f'https://reddit.com{comment["comment_url"]}')
- page.locator(f"#t1_{comment['comment_id']}").screenshot(
- path=f"assets/png/comment_{idx}.png"
+ if storymode:
+ page.locator('[data-click-id="text"]').screenshot(
+ path="assets/temp/png/story_content.png"
)
+ else:
+ for idx, comment in enumerate(
+ track(reddit_object["comments"], "Downloading screenshots...")
+ ):
+ # Stop if we have reached the screenshot_num
+ if idx >= screenshot_num:
+ break
+
+ if page.locator('[data-testid="content-gate"]').is_visible():
+ page.locator('[data-testid="content-gate"] button').click()
+
+ page.goto(f'https://reddit.com{comment["comment_url"]}', timeout=0)
+
+ # translate code
+
+ if getenv("POSTLANG"):
+ comment_tl = ts.google(
+ comment["comment_body"], to_language=os.getenv("POSTLANG")
+ )
+ page.evaluate(
+ '([tl_content, tl_id]) => document.querySelector(`#t1_${tl_id} > div:nth-child(2) > div > div[data-testid="comment"] > div`).textContent = tl_content',
+ [comment_tl, comment["comment_id"]],
+ )
+
+ page.locator(f"#t1_{comment['comment_id']}").screenshot(
+ path=f"assets/temp/png/comment_{idx}.png"
+ )
print_substep("Screenshots downloaded Successfully.", style="bold green")
diff --git a/video_creation/voices.py b/video_creation/voices.py
index 1a83735..5105a10 100644
--- a/video_creation/voices.py
+++ b/video_creation/voices.py
@@ -1,48 +1,57 @@
-#!/usr/bin/env python3
-from gtts import gTTS
-from pathlib import Path
-from mutagen.mp3 import MP3
-from utils.console import print_step, print_substep
-from rich.progress import track
-import re
+#!/usr/bin/env python
+import os
+from typing import Dict, Tuple
-def save_text_to_mp3(reddit_obj):
- """Saves Text to MP3 files.
+from rich.console import Console
+
+from TTS.engine_wrapper import TTSEngine
+from TTS.GTTS import GTTS
+from TTS.streamlabs_polly import StreamlabsPolly
+from TTS.aws_polly import AWSPolly
+from TTS.TikTok import TikTok
+
+from utils.console import print_table, print_step
+
+
+console = Console()
+
+TTSProviders = {
+ "GoogleTranslate": GTTS,
+ "AWSPolly": AWSPolly,
+ "StreamlabsPolly": StreamlabsPolly,
+ "TikTok": TikTok,
+}
+
+
+def save_text_to_mp3(reddit_obj) -> Tuple[int, int]:
+ """Saves text to MP3 files.
Args:
- reddit_obj : The reddit object you received from the reddit API in the askreddit.py file.
+ reddit_obj (dict[str]): Reddit object received from reddit API in reddit/subreddit.py
+
+ Returns:
+ tuple[int,int]: (total length of the audio, the number of comments audio was generated for)
"""
- print_step("Saving Text to MP3 files...")
- length = 0
-
- # Create a folder for the mp3 files.
- Path("assets/mp3").mkdir(parents=True, exist_ok=True)
-
- tts = gTTS(text=reddit_obj["thread_title"], lang="en", slow=False)
- tts.save("assets/mp3/title.mp3")
- length += MP3("assets/mp3/title.mp3").info.length
-
- try:
- Path("assets/mp3/posttext.mp3").unlink()
- except OSError:
- pass
-
- if reddit_obj["thread_post"] != "":
- tts = gTTS(text=reddit_obj["thread_post"], lang="en", slow=False)
- tts.save("assets/mp3/posttext.mp3")
- length += MP3("assets/mp3/posttext.mp3").info.length
-
- for idx, comment in track(enumerate(reddit_obj["comments"]), "Saving..."):
- # ! Stop creating mp3 files if the length is greater than 50 seconds. This can be longer, but this is just a good starting point
- if length > 50:
- break
- comment=comment["comment_body"]
- text=re.sub('((http|https)\:\/\/)?[a-zA-Z0-9\.\/\?\:@\-_=#]+\.([a-zA-Z]){2,6}([a-zA-Z0-9\.\&\/\?\:@\-_=#])*', '', comment)
- tts = gTTS(text, lang="en", slow=False)
- tts.save(f"assets/mp3/{idx}.mp3")
- length += MP3(f"assets/mp3/{idx}.mp3").info.length
-
- print_substep("Saved Text to MP3 files successfully.", style="bold green")
- # ! Return the index so we know how many screenshots of comments we need to make.
- return length, idx
+
+ env = os.getenv("TTSCHOICE", "")
+ if env.casefold() in map(lambda _: _.casefold(), TTSProviders):
+ text_to_mp3 = TTSEngine(get_case_insensitive_key_value(TTSProviders, env), reddit_obj)
+ else:
+ while True:
+ print_step("Please choose one of the following TTS providers: ")
+ print_table(TTSProviders)
+ choice = input("\n")
+ if choice.casefold() in map(lambda _: _.casefold(), TTSProviders):
+ break
+ print("Unknown Choice")
+ text_to_mp3 = TTSEngine(get_case_insensitive_key_value(TTSProviders, choice), reddit_obj)
+
+ return text_to_mp3.run()
+
+
+def get_case_insensitive_key_value(input_dict, key):
+ return next(
+ (value for dict_key, value in input_dict.items() if dict_key.lower() == key.lower()),
+ None,
+ )
-](https://tmrrwinc.ca)
+