Merge pull request #524 from elebumm/develop

Develop > master

.env.template

@@ -1,20 +1,39 @@
+# This can be found in the email that reddit sent you when you created the app
 REDDIT_CLIENT_ID=""
 REDDIT_CLIENT_SECRET=""
 
 REDDIT_USERNAME=""
 REDDIT_PASSWORD=""
 
-# Valid options are "yes" and "no"
+# If no, it will ask you a thread link to extract the thread, if yes it will randomize it. Default: "no"
-REDDIT_2FA=""
+RANDOM_THREAD=""
 
-#If no, it will ask you a thread link to extract the thread, if yes it will randomize it.
+# Filters the comments by range of lenght (min and max characters)
-RANDOM_THREAD="yes"
+# 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"
 
-# Valid options are "light" and "dark"
+# The absolute path of the folder where you want to save the final video
-THEME=""
+# If empty or wrong, the path will be 'results/'
+FINAL_VIDEO_PATH=""
+# Valid options are "yes" and "no" for the variable below
+REDDIT_2FA=""
+SUBREDDIT="AskReddit"
+# True or False
+ALLOW_NSFW="False"
+# Used if you want to use a specific post. example of one is urdtfx
+POST_ID=""
+#set to either LIGHT or DARK
+THEME="LIGHT"
+# used if you want to run multiple times. set to an int e.g. 4 or 29 and leave blank for once
+TIMES_TO_RUN=""
+MAX_COMMENT_LENGTH="500"
+# Range is 0 -> 1 recommended around 0.8-0.9
+OPACITY="1"
 
-# Enter a subreddit, e.g. "AskReddit"
+# see TTSwrapper.py for all valid options
-SUBREDDIT=""
+VOICE="Matthew" # e.g. en_us_002
+TTsChoice="polly" # todo add docs
 
-# Range is 0 -> 1
+# IN-PROGRESS - not yet implemented
-OPACITY="0.9"
+STORYMODE="False"

.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"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# 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

.gitignore

@@ -1,11 +1,172 @@
-assets/
+# Byte-compiled / optimized / DLL files
-reddit/__pycache__/
+__pycache__/
-utils/__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
 .env
-reddit-bot-351418-5560ebc49cac.json
+.venv
-video_creation/__pycache__/
+env/
-.setup-done-before
+venv/
-__pycache__
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+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/
-.DS_Store
+
+assets/
 out
+.DS_Store
+.setup-done-before
+assets/
+results/*
+.env
+reddit-bot-351418-5560ebc49cac.json
+/.idea
+*.pyc
+/video_creation/data/videos.json

.pylintrc

@@ -0,0 +1,614 @@
+[MAIN]
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Load and enable all available extensions. Use --list-extensions to see a list
+# all available extensions.
+#enable-all-extensions=
+
+# In error mode, checkers without error messages are disabled and for others,
+# only the ERROR messages are displayed, and no reports are done by default.
+#errors-only=
+
+# Always return a 0 (non-error) status code, even if lint errors are found.
+# This is primarily useful in continuous integration scripts.
+#exit-zero=
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-allow-list=
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
+# for backward compatibility.)
+extension-pkg-whitelist=
+
+# Return non-zero exit code if any of these messages/categories are detected,
+# even if score is above --fail-under value. Syntax same as enable. Messages
+# specified are enabled, while categories only check already-enabled messages.
+fail-on=
+
+# Specify a score threshold to be exceeded before program exits with error.
+fail-under=10
+
+# Interpret the stdin as a python script, whose filename needs to be passed as
+# the module_or_package argument.
+#from-stdin=
+
+# Files or directories to be skipped. They should be base names, not paths.
+ignore=CVS
+
+# Add files or directories matching the regex patterns to the ignore-list. The
+# regex matches against paths and can be in Posix or Windows format.
+ignore-paths=
+
+# Files or directories matching the regex patterns are skipped. The regex
+# matches against base names, not paths. The default value ignores Emacs file
+# locks
+ignore-patterns=^\.#
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis). It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=1
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python module names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# Minimum Python version to use for version dependent checks. Will default to
+# the version used to run pylint.
+py-version=3.6
+
+# Discover python modules and packages in the file system subtree.
+recursive=no
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+# In verbose mode, extra non-checker-related info will be displayed.
+#verbose=
+
+
+[REPORTS]
+
+# Python expression which should return a score less than or equal to 10. You
+# have access to the variables 'fatal', 'error', 'warning', 'refactor',
+# 'convention', and 'info' which contain the number of messages in each
+# category, as well as 'statement' which is the total number of statements
+# analyzed. This score is used by the global evaluation report (RP0004).
+evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+#output-format=
+
+# Tells whether to display a full report or only the messages.
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
+# UNDEFINED.
+confidence=HIGH,
+           CONTROL_FLOW,
+           INFERENCE,
+           INFERENCE_FAILURE,
+           UNDEFINED
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then re-enable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        use-symbolic-message-instead
+        attribute-defined-outside-init,
+        invalid-name,
+        missing-docstring,
+        protected-access,
+        too-few-public-methods,
+        format, # handled by black
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=c-extension-no-member
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style. If left empty, argument names will be checked with the set
+# naming style.
+#argument-rgx=
+
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style. If left empty, attribute names will be checked with the set naming
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+          bar,
+          baz,
+          toto,
+          tutu,
+          tata
+
+# Bad variable names regexes, separated by a comma. If names match any regex,
+# they will always be refused
+bad-names-rgxs=
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style. If left empty, class attribute names will be checked
+# with the set naming style.
+#class-attribute-rgx=
+
+# Naming style matching correct class constant names.
+class-const-naming-style=UPPER_CASE
+
+# Regular expression matching correct class constant names. Overrides class-
+# const-naming-style. If left empty, class constant names will be checked with
+# the set naming style.
+#class-const-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style. If left empty, class names will be checked with the set naming style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style. If left empty, constant names will be checked with the set naming
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style. If left empty, function names will be checked with the set
+# naming style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=i,
+           j,
+           k,
+           ex,
+           Run,
+           _
+
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs=
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style. If left empty, inline iteration names will be checked
+# with the set naming style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style. If left empty, method names will be checked with the set naming style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style. If left empty, module names will be checked with the set naming style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Regular expression matching correct type variable names. If left empty, type
+# variable names will be checked with the set naming style.
+#typevar-rgx=
+
+# Naming style matching correct variable names.
+variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style. If left empty, variable names will be checked with the set
+# naming style.
+#variable-rgx=
+
+
+[CLASSES]
+
+# Warn about protected attribute access inside special methods
+check-protected-access-in-special-methods=no
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp,
+                      __post_init__
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+                  _fields,
+                  _replace,
+                  _source,
+                  _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=cls
+
+
+[DESIGN]
+
+# List of regular expressions of class ancestor names to ignore when counting
+# public methods (see R0903)
+exclude-too-few-public-methods=
+
+# List of qualified class names to ignore when counting class parents (see
+# R0901)
+ignored-parents=
+
+# Maximum number of arguments for function / method.
+max-args=5
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement (see R0916).
+max-bool-expr=5
+
+# Maximum number of branch for function / method body.
+max-branches=12
+
+# Maximum number of locals for function / method body.
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=7
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when caught.
+overgeneral-exceptions=BaseException,
+                       Exception
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
+# tab).
+indent-string='    '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[IMPORTS]
+
+# List of modules that can be imported at any level, not just the top level
+# one.
+allow-any-import-level=
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=
+
+# Output a graph (.gv or any supported image format) of external dependencies
+# to the given file (report RP0402 must not be disabled).
+ext-import-graph=
+
+# Output a graph (.gv or any supported image format) of all (i.e. internal and
+# external) dependencies to the given file (report RP0402 must not be
+# disabled).
+import-graph=
+
+# Output a graph (.gv or any supported image format) of internal dependencies
+# to the given file (report RP0402 must not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+# Couples of modules and preferred modules, separated by a comma.
+preferred-modules=
+
+
+[LOGGING]
+
+# The type of string formatting that logging methods do. `old` means using %
+# formatting, `new` is for `{}` formatting.
+logging-format-style=old
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+      XXX,
+      TODO
+
+# Regular expression of note tags to take in consideration.
+notes-rgx=
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit,argparse.parse_error
+
+
+[SIMILARITIES]
+
+# Comments are removed from the similarity computation
+ignore-comments=yes
+
+# Docstrings are removed from the similarity computation
+ignore-docstrings=yes
+
+# Imports are removed from the similarity computation
+ignore-imports=yes
+
+# Signatures are removed from the similarity computation
+ignore-signatures=yes
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it work,
+# install the 'python-enchant' package.
+spelling-dict=
+
+# List of comma separated words that should be considered directives if they
+# appear at the beginning of a comment and should not be checked.
+spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains the private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to the private dictionary (see the
+# --spelling-private-dict-file option) instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=no
+
+# This flag controls whether the implicit-str-concat should generate a warning
+# on implicit string concatenation in sequences defined over several lines.
+check-str-concat-over-line-jumps=no
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of symbolic message names to ignore for Mixin members.
+ignored-checks-for-mixins=no-member,
+                          not-async-context-manager,
+                          not-context-manager,
+                          attribute-defined-outside-init
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+# Regex pattern to define which classes are considered mixins.
+mixin-class-rgx=.*[Mm]ixin
+
+# List of decorators that change the signature of a decorated function.
+signature-mutators=
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid defining new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of names allowed to shadow builtins
+allowed-redefined-builtins=
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+          _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io

CONTRIBUTING.md

@@ -12,11 +12,17 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 
 ## Table of Contents
 
+- [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
@@ -39,7 +45,7 @@ Additionally, there is a [Discord Server](https://discord.gg/swqtb7AsNQ) for any
 
 ### Reporting Bugs
 
-#### Before Submitting a Bug Report
+<details><summary><h4>Before Submitting a Bug Report</h4></summary>
 
 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.
 
@@ -68,12 +74,13 @@ 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 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).
+</details>
 
 ### Suggesting Enhancements
 
 This section guides you through submitting an enhancement suggestion for Reddit Video Maker Bot, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
 
-#### Before Submitting an Enhancement
+<details><summary><h4>Before Submitting an Enhancement</h4></summary>
 
 - Make sure that you are using the latest version.
 - Read the [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
@@ -90,6 +97,8 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/elebum
 - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
 - **Explain why this enhancement would be useful** to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
 
+</details>
+
 ### Your First Code Contribution
 
 #### Your environment

README.md

@@ -1,7 +1,5 @@
 # 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)
@@ -16,42 +14,49 @@ Created by Lewis Menelaws & [TMRRW](https://tmrrwinc.ca)
 </a>
 
 ## Video Explainer
+
 [![lewisthumbnail](https://user-images.githubusercontent.com/6053155/173631669-1d1b14ad-c478-4010-b57d-d79592a789f2.png)
 ](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
--   **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.
+  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)
+- Playwright (this should install automatically in installation)
+- Sox
 
 ## Installation 👩‍💻
 
 1. Clone this repository
+2. 2a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant.
+
+   2b **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.
 
-2. Run `pip3 install -r requirements.txt`
+3. install [SoX](https://sourceforge.net/projects/sox/files/sox/)
-3. Run `playwright install` and `playwright install-deps`.
 4.
-	4a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant.
+5. Run `pip3 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.
+6. Run `playwright install` and `playwright install-deps`.
 
-5. Run `python3 main.py` (unless you chose automatic install, then the installer will automatically run main.py)
+7. Run `python3 main.py` (unless you chose automatic install, then the installer will automatically run main.py)
-7. Enjoy 😎
+   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.
+8. Enjoy 😎
 
+## Video
 
-If you want to see more detailed guide, please refer to the official [documentation](https://luka-hietala.gitbook.io/documentation-for-the-reddit-bot/).
+https://user-images.githubusercontent.com/66544866/173453972-6526e4e6-c6ef-41c5-ab40-5d275e724e7c.mp4
-\*The Documentation is still being developed and worked on, please be patient as we change / add new knowledge!
 
 ## Contributing & Ways to improve 📈
 
@@ -59,11 +64,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!
 
+- [ ] Creating better documentation and adding a command line interface.
 - [x] Allowing users to choose a reddit thread instead of being randomized.
-- [ ] Allowing users to choose a background that is picked instead of the Minecraft one.
+- [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.
+- [x] Allowing users to change voice.
-- [ ] Creating better documentation and adding a command line interface.
+- [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.
 
@@ -73,10 +81,10 @@ Elebumm (Lewis#6305) - https://github.com/elebumm (Founder)
 
 Jason (JasonLovesDoggo#1904) - https://github.com/JasonLovesDoggo
 
-CallumIO - https://github.com/CallumIO
+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

TTS/GTTS.py

@@ -0,0 +1,13 @@
+from gtts import gTTS
+
+
+class GTTS:
+    def tts(
+        self,
+        req_text: str = "Google Text To Speech",
+        filename: str = "title.mp3",
+        random_speaker=False,
+        censer=False,
+    ):
+        tts = gTTS(text=req_text, lang="en", slow=False)
+        tts.save(f"{filename}")

TTS/POLLY.py

@@ -0,0 +1,86 @@
+import os
+import random
+import re
+
+import requests
+import sox
+from moviepy.audio.AudioClip import concatenate_audioclips, CompositeAudioClip
+from moviepy.audio.io.AudioFileClip import AudioFileClip
+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 POLLY:
+    def __init__(self):
+        self.url = 'https://streamlabs.com/polly/speak'
+
+    def tts(
+            self,
+            req_text: str = "Amazon Text To Speech",
+            filename: str = "title.mp3",
+            random_speaker=False,
+            censer=False,
+    ):
+        if random_speaker:
+            voice = self.randomvoice()
+        else:
+            if not os.getenv('VOICE'):
+                return ValueError('Please set the environment variable VOICE to a valid voice. options are: {}'.format(voices))
+            voice = str(os.getenv("VOICE")).capitalize()
+        body = {'voice': voice, 'text': req_text, 'service': 'polly'}
+        response = requests.post(self.url, data=body)
+        try:
+            voice_data = requests.get(response.json()['speak_url'])
+            with open(filename, 'wb') as f:
+                f.write(voice_data.content)
+        except (KeyError, JSONDecodeError):
+            if response.json()['error'] == 'Text length is too long!':
+                chunks = [
+                    m.group().strip() for m in re.finditer(r" *((.{0,499})(\.|.$))", req_text)
+                ]
+
+                audio_clips = []
+                cbn = sox.Combiner()
+
+                chunkId = 0
+                for chunk in chunks:
+                    body = {'voice': voice, 'text': chunk, 'service': 'polly'}
+                    resp = requests.post(self.url, data=body)
+                    voice_data = requests.get(resp.json()['speak_url'])
+                    with open(filename.replace(".mp3", f"-{chunkId}.mp3"), "wb") as out:
+                        out.write(voice_data.content)
+
+                    audio_clips.append(filename.replace(".mp3", f"-{chunkId}.mp3"))
+
+                    chunkId = chunkId + 1
+                try:
+                    if len(audio_clips) > 1:
+                        cbn.convert(samplerate=44100, n_channels=2)
+                        cbn.build(audio_clips, filename, "concatenate")
+                    else:
+                        os.rename(audio_clips[0], filename)
+                except (sox.core.SoxError,
+                        FileNotFoundError):  # https://github.com/JasonLovesDoggo/RedditVideoMakerBot/issues/67#issuecomment-1150466339
+                    for clip in audio_clips:
+                        i = audio_clips.index(clip)  # get the index of the clip
+                        audio_clips = (
+                                audio_clips[:i] + [AudioFileClip(clip)] + audio_clips[i + 1:]
+                        )  # replace the clip with an AudioFileClip
+                    audio_concat = concatenate_audioclips(audio_clips)
+                    audio_composite = CompositeAudioClip([audio_concat])
+                    audio_composite.write_audiofile(filename, 44100, 2, 2000, None)
+
+    def make_readable(self, text):
+        """
+        Amazon Polly fails to read some symbols properly such as '& (and)'.
+        So we normalize input text before passing it to the service
+        """
+        text = text.replace('&', 'and')
+        return text
+
+    def randomvoice(self):
+        return random.choice(voices)

TTS/TikTok.py

@@ -0,0 +1,144 @@
+import base64
+import os
+import random
+import re
+
+import requests
+import sox
+from moviepy.audio.AudioClip import concatenate_audioclips, CompositeAudioClip
+from moviepy.audio.io.AudioFileClip import AudioFileClip
+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="
+
+    def tts(
+        self,
+        req_text: str = "TikTok Text To Speech",
+        filename: str = "title.mp3",
+        random_speaker: bool = False,
+        censer=False,
+    ):
+        req_text = req_text.replace("+", "plus").replace(" ", "+").replace("&", "and")
+        if censer:
+            # req_text = pf.censor(req_text)
+            pass
+        voice = (
+            self.randomvoice()
+            if random_speaker
+            else (os.getenv("VOICE") or random.choice(human))
+        )
+
+        chunks = [
+            m.group().strip() for m in re.finditer(r" *((.{0,299})(\.|.$))", req_text)
+        ]
+
+        audio_clips = []
+        cbn = sox.Combiner()
+        # cbn.set_input_format(file_type=["mp3" for _ in chunks])
+
+        chunkId = 0
+        for chunk in chunks:
+            try:
+                r = requests.post(
+                    f"{self.URI_BASE}{voice}&req_text={chunk}&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={chunk}&speaker_map_type=0"
+                )
+            print(r.text)
+            vstr = [r.json()["data"]["v_str"]][0]
+            b64d = base64.b64decode(vstr)
+
+            with open(filename.replace(".mp3", f"-{chunkId}.mp3"), "wb") as out:
+                out.write(b64d)
+
+            audio_clips.append(filename.replace(".mp3", f"-{chunkId}.mp3"))
+
+            chunkId = chunkId + 1
+        try:
+            if len(audio_clips) > 1:
+                cbn.convert(samplerate=44100, n_channels=2)
+                cbn.build(audio_clips, filename, "concatenate")
+            else:
+                os.rename(audio_clips[0], filename)
+        except (sox.core.SoxError, FileNotFoundError):  # https://github.com/JasonLovesDoggo/RedditVideoMakerBot/issues/67#issuecomment-1150466339
+            for clip in audio_clips:
+                i = audio_clips.index(clip)  # get the index of the clip
+                audio_clips = (
+                    audio_clips[:i] + [AudioFileClip(clip)] + audio_clips[i + 1 :]
+                )  # replace the clip with an AudioFileClip
+            audio_concat = concatenate_audioclips(audio_clips)
+            audio_composite = CompositeAudioClip([audio_concat])
+            audio_composite.write_audiofile(filename, 44100, 2, 2000, None)
+
+    @staticmethod
+    def randomvoice():
+        ok_or_good = random.randrange(1, 10)
+        if ok_or_good == 1:  # 1/10 chance of ok voice
+            return random.choice(voices)
+        return random.choice(human)  # 9/10 chance of good voice

TTS/swapper.py

@@ -0,0 +1,21 @@
+from os import getenv
+
+from dotenv import load_dotenv
+
+from TTS.GTTS import GTTS
+from TTS.POLLY import POLLY
+from TTS.TikTok import TikTok
+
+CHOICE_DIR = {"tiktok": TikTok, "gtts": GTTS, 'polly': POLLY}
+
+
+class TTS:
+    def __new__(cls):
+        load_dotenv()
+        CHOICE = getenv("TTsChoice").casefold()
+        valid_keys = [key.lower() for key in CHOICE_DIR.keys()]
+        if CHOICE not in valid_keys:
+            raise ValueError(
+                f"{CHOICE} is not valid. Please use one of these {valid_keys} options"
+            )
+        return CHOICE_DIR.get(CHOICE)()

build.sh

@@ -1 +1,2 @@
+#!/bin/sh
 docker build -t rvmt .

main.py

@@ -1,100 +1,72 @@
-# Main
-from utils.console import print_markdown
-from utils.console import print_step
-from utils.console import print_substep
-from rich.console import Console
 import time
+
+from subprocess import Popen
+from dotenv import load_dotenv
+from os import getenv, name
 from reddit.subreddit import get_subreddit_threads
+from utils.cleanup import cleanup
+from utils.console import print_markdown, print_step
 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 utils.loader import Loader
+from video_creation.screenshot_downloader import download_screenshots_of_reddit_posts
-from dotenv import load_dotenv
+from video_creation.voices import save_text_to_mp3
-
-console = Console()
-from dotenv import load_dotenv
-import os, time, shutil
-
-configured = True
-REQUIRED_VALUES = [
-    "REDDIT_CLIENT_ID",
-    "REDDIT_CLIENT_SECRET",
-    "REDDIT_USERNAME",
-    "REDDIT_PASSWORD",
-    "OPACITY",
-]
-
 
+banner = """
+██████╗ ███████╗██████╗ ██████╗ ██╗████████╗    ██╗   ██╗██╗██████╗ ███████╗ ██████╗     ███╗   ███╗ █████╗ ██╗  ██╗███████╗██████╗ 
+██╔══██╗██╔════╝██╔══██╗██╔══██╗██║╚══██╔══╝    ██║   ██║██║██╔══██╗██╔════╝██╔═══██╗    ████╗ ████║██╔══██╗██║ ██╔╝██╔════╝██╔══██╗
+██████╔╝█████╗  ██║  ██║██║  ██║██║   ██║       ██║   ██║██║██║  ██║█████╗  ██║   ██║    ██╔████╔██║███████║█████╔╝ █████╗  ██████╔╝
+██╔══██╗██╔══╝  ██║  ██║██║  ██║██║   ██║       ╚██╗ ██╔╝██║██║  ██║██╔══╝  ██║   ██║    ██║╚██╔╝██║██╔══██║██╔═██╗ ██╔══╝  ██╔══██╗
+██║  ██║███████╗██████╔╝██████╔╝██║   ██║        ╚████╔╝ ██║██████╔╝███████╗╚██████╔╝    ██║ ╚═╝ ██║██║  ██║██║  ██╗███████╗██║  ██║
+╚═╝  ╚═╝╚══════╝╚═════╝ ╚═════╝ ╚═╝   ╚═╝         ╚═══╝  ╚═╝╚═════╝ ╚══════╝ ╚═════╝     ╚═╝     ╚═╝╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝
+"""
+print(banner)
+load_dotenv()
+# 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/)"
 )
 
-"""
+time.sleep(1)
 
-Load .env file if exists. If it doesnt exist, print a warning and launch the setup wizard.
+client_id = getenv("REDDIT_CLIENT_ID")
-If there is a .env file, check if the required variables are set. If not, print a warning and launch the setup wizard.
+client_secret = getenv("REDDIT_CLIENT_SECRET")
+username = getenv("REDDIT_USERNAME")
+password = getenv("REDDIT_PASSWORD")
+reddit2fa = getenv("REDDIT_2FA")
 
-"""
-load_dotenv()
 
-client_id = os.getenv("REDDIT_CLIENT_ID")
+def main():
-client_secret = os.getenv("REDDIT_CLIENT_SECRET")
+    cleanup()
-username = os.getenv("REDDIT_USERNAME")
-password = os.getenv("REDDIT_PASSWORD")
-reddit2fa = os.getenv("REDDIT_2FA")
 
+    def get_obj():
+        reddit_obj = get_subreddit_threads()
+        return reddit_obj
 
-console.log("[bold green]Checking environment variables...")
+    reddit_object = get_obj()
-time.sleep(1)
+    length, number_of_comments = save_text_to_mp3(reddit_object)
+    download_screenshots_of_reddit_posts(reddit_object, number_of_comments)
+    download_background()
+    chop_background_video(length)
+    final_video = make_final_video(number_of_comments, length)
 
 
-if not os.path.exists(".env"):
+def run_many(times):
-    configured = False
+    for x in range(times):
-    console.log("[red] Your .env file is invalid, or was never created. Standby.")
+        x = x + 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()
 
-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")
 
-        elif setup_ask == "no":
+if __name__ == "__main__":
-            console.print("[red]Exiting...")
-            time.sleep(0.5)
-            exit()
-        else:
-            console.print("[red]I don't understand that. Exiting...")
-            time.sleep(0.5)
-            exit()
     try:
-    float(os.getenv("OPACITY"))
+        if getenv("TIMES_TO_RUN") and isinstance(int(getenv("TIMES_TO_RUN")), int):
-except:
+            run_many(int(getenv("TIMES_TO_RUN")))
-    console.log(
+        else:
-        f"[red]Please ensure that OPACITY is set between 0 and 1 in your .env file"
+            main()
-    )
+    except KeyboardInterrupt:
-    configured = False
+        print_markdown("## Clearing temp files")
+        cleanup()
         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")
-    )
-    download_background()
-    chop_background_video(length)
-    final_video = make_final_video(number_of_comments)

reddit/subreddit.py

@@ -1,72 +1,97 @@
-from rich.console import Console
+from os import getenv, environ
-from utils.console import print_markdown, print_step, print_substep
-from dotenv import load_dotenv
 
-console = Console()
+import praw
-import os, random, praw, re
+
+from utils.console import print_step, print_substep
+from utils.subreddit import get_subreddit_undone
+from utils.videos import check_done
+from praw.models import MoreComments
+
+TEXT_WHITELIST = set("abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ 1234567890")
+
+
+def textify(text):
+    return "".join(filter(TEXT_WHITELIST.__contains__, text))
 
 
 def get_subreddit_threads():
-    global submission
     """
     Returns a list of threads from the AskReddit subreddit.
     """
+    global submission
+    print_substep("Logging into Reddit.")
 
-    load_dotenv()
+    content = {}
-
+    if str(getenv("REDDIT_2FA")).casefold() == "yes":
-    if os.getenv("REDDIT_2FA", default="no").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")
+        passkey = getenv("REDDIT_PASSWORD")
-
-    content = {}
     reddit = praw.Reddit(
-        client_id=os.getenv("REDDIT_CLIENT_ID"),
+        client_id=getenv("REDDIT_CLIENT_ID"),
-        client_secret=os.getenv("REDDIT_CLIENT_SECRET"),
+        client_secret=getenv("REDDIT_CLIENT_SECRET"),
-        user_agent="Accessing AskReddit threads",
+        user_agent="Accessing Reddit threads",
-        username=os.getenv("REDDIT_USERNAME"),
+        username=getenv("REDDIT_USERNAME"),
-        password=passkey,
+        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
+    Ask user for subreddit input
-    if not os.getenv("RANDOM_THREAD") or os.getenv("RANDOM_THREAD") == "no":
+    """
-        print_substep("Insert the full thread link:", style="bold green")
+    print_step("Getting subreddit threads...")
-        thread_link = input()
+    if not getenv(
-        print_step(f"Getting the inserted thread...")
+        "SUBREDDIT"
-        submission = reddit.submission(url=thread_link)
+    ):  # note to self. you can have multiple subreddits via reddit.subreddit("redditdev+learnpython")
-    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? "))
+            input("What subreddit would you like to pull from? ")
+        )  # if the env isnt set, ask user
+    else:
+        print_substep(
+            f"Using subreddit: r/{getenv('SUBREDDIT')} from environment variable config"
         )
-            except ValueError:
+        subreddit = reddit.subreddit(
-                subreddit = reddit.subreddit("askreddit")
+            getenv("SUBREDDIT")
-                print_substep("Subreddit not defined. Using AskReddit.")
+        )  # Allows you to specify in .env. Done for automation purposes.
 
+    if getenv("POST_ID"):
+        submission = reddit.submission(id=getenv("POST_ID"))
+    else:
         threads = subreddit.hot(limit=25)
-        submission = list(threads)[random.randrange(0, 25)]
+        submission = get_subreddit_undone(threads, subreddit)
+    submission = check_done(submission)  # double checking
+    if submission is None:
+        return get_subreddit_threads()  # submission already done. rerun
+    upvotes = submission.score
+    ratio = submission.upvote_ratio * 100
+    num_comments = submission.num_comments
 
-    print_substep(f"Video will be: {submission.title} :thumbsup:")
+    print_substep(f"Video will be: {submission.title} :thumbsup:", style="bold green")
-    console.log("Getting video comments...")
+    print_substep(f"Thread has " + str(upvotes) + " upvotes", style="bold blue")
-    try:
+    print_substep(
-        content["thread_url"] = submission.url
+        f"Thread has a upvote ratio of " + str(ratio) + "%", style="bold blue"
+    )
+    print_substep(f"Thread has " + str(num_comments) + " comments", style="bold blue")
+    environ["VIDEO_TITLE"] = str(
+        textify(submission.title)
+    )  # todo use global instend of env vars
+    environ["VIDEO_ID"] = str(textify(submission.id))
+
+    content["thread_url"] = f"https://reddit.com{submission.permalink}"
     content["thread_title"] = submission.title
-        content["thread_post"] = submission.selftext
+    # content["thread_content"] = submission.content
     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(environ["MAX_COMMENT_LENGTH"]):
                 content["comments"].append(
                     {
                         "comment_body": top_level_comment.body,
@@ -74,9 +99,5 @@ def get_subreddit_threads():
                         "comment_id": top_level_comment.id,
                     }
                 )
-
+    print_substep("Received subreddit threads Successfully.", style="bold green")
-    except AttributeError as e:
-        pass
-    print_substep(f"Received {subreddit} threads successfully.", style="bold green")
-
     return content

requirements.txt

@@ -4,5 +4,7 @@ mutagen==1.45.1
 playwright==1.22.0
 praw==7.6.0
 python-dotenv==0.20.0
+pytube==12.1.0
+requests==2.28.0
 rich==12.4.4
-yt_dlp==2022.5.18
+sox==1.4.1

run.sh

@@ -1 +1,2 @@
+#!/bin/sh
 docker run -v $(pwd)/out/:/app/assets -v $(pwd)/.env:/app/.env -it rvmt

setup.py

@@ -1,24 +1,65 @@
-"""
+#!/usr/bin/env python3
-
+# Setup Script for RedditVideoMakerBot
-Setup Script for RedditVideoMakerBot
 
-"""
 
 # Imports
 import os
-import time
+import subprocess
+import re
 from utils.console import print_markdown
 from utils.console import print_step
-from utils.console import print_substep
 from rich.console import Console
 from utils.loader import Loader
-from os.path import exists
+
 console = Console()
 
-setup_done = exists(".setup-done-before")
 
-if setup_done == True:
+def handle_input(
-	console.log("[red]Setup was already completed! Please make sure you have to run this script again. If you have to, please delete the file .setup-done-before")
+    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:
@@ -26,30 +67,32 @@ if setup_done == True:
 # - 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.
-ensureSetupIsRequired = input("Are you sure you want to continue? > ").casefold()
+if input("Are you sure you want to continue? > ").strip().casefold() != "yes":
-if ensureSetupIsRequired != "yes":
     console.print("[red]Exiting...")
-	time.sleep(0.5)
     exit()
-else:
+# 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")
+console.print(
-	overwriteSettings = input("Are you sure you want to continue? > ").casefold()
+    "[bold red] This will overwrite your current settings. Are you sure you want to continue? [bold green]yes/no"
-	if overwriteSettings != "yes":
+)
+
+
+if input("Are you sure you want to continue? > ").strip().casefold() != "yes":
     console.print("[red]Abort mission! Exiting...")
-		time.sleep(0.5)
     exit()
-	else:
+# 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!")
-		time.sleep(1)
 
+print()
 console.log("Ensure you have the following ready to enter:")
 console.log("[bold green]Reddit Client ID")
 console.log("[bold green]Reddit Client Secret")
@@ -59,64 +102,108 @@ 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)")
-time.sleep(0.5)
+console.print(
-console.print("[green]If you don't have these, please follow the instructions in the README.md file to set them up.")
+    "[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.")
+)
-confirmUserHasCredentials = input("Are you sure you have the credentials? > ").casefold()
+console.print(
-if confirmUserHasCredentials != "yes":
+    "[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()
-else:
-	console.print("[bold green]Alright! Let's get started!")
-	time.sleep(1)
 
-"""
 
-Begin the setup process.
+console.print("[bold green]Alright! Let's get started!")
 
-"""
+# Begin the setup process.
 
 console.log("Enter your credentials now.")
-cliID = input("Client ID > ")
+client_id = handle_input(
-cliSec = input("Client Secret > ")
+    "Client ID > ",
-user = input("Username > ")
+    False,
-passw = input("Password > ")
+    "[-a-zA-Z0-9._~+/]+=*",
-twofactor = input("2fa Enabled? (yes/no) > ")
+    "That is somehow not a correct ID, try again.",
-opacity = input("Opacity? (range of 0-1) > ")
+    12,
-subreddit = input("Subreddit (without r/) > ")
+    30,
-theme = input("Theme? (light or dark) > ")
+    "The ID should be over 12 and under 30 characters, double check your input.",
-console.log("Attempting to save your credentials...")
+)
-loader = Loader("Saving Credentials...", "Done!").start()
+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: ...
-time.sleep(0.5)
+console.log("Writing to the .env file...")
-console.log("Removing old .env file...")
+with open(".env", "w") as f:
-os.remove(".env")
+    f.write(
-time.sleep(0.5)
+        f"""REDDIT_CLIENT_ID="{client_id}"
-console.log("Creating new .env file...")
+REDDIT_CLIENT_SECRET="{client_sec}"
-with open('.env', 'a') as f:
+REDDIT_USERNAME="{user}"
-	f.write(f'REDDIT_CLIENT_ID="{cliID}"\n')
+REDDIT_PASSWORD="{passw}"
-	time.sleep(0.5)
+REDDIT_2FA="{twofactor}"
-	f.write(f'REDDIT_CLIENT_SECRET="{cliSec}"\n')
+THEME="{theme}"
-	time.sleep(0.5)
+SUBREDDIT="{subreddit}"
-	f.write(f'REDDIT_USERNAME="{user}"\n')
+OPACITY={opacity}
-	time.sleep(0.5)
+"""
-	f.write(f'REDDIT_PASSWORD="{passw}"\n')
+    )
-	time.sleep(0.5)
+
-	f.write(f'REDDIT_2FA="{twofactor}"\n')
+with open(".setup-done-before", "w") as f:
-	time.sleep(0.5)
+    f.write(
-	f.write(f'THEME="{theme}"\n')
+        "This file blocks the setup assistant from running again. Delete this file to run setup again."
-	time.sleep(0.5)
+    )
-	f.write(f'SUBREDDIT="{subreddit}"\n')
-	time.sleep(0.5)
-	f.write(f'OPACITY="{opacity}"\n')
-
-with open('.setup-done-before', 'a') 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.
-os.system("python3 main.py")
+subprocess.call("python3 main.py", shell=True)

utils/cleanup.py

@@ -0,0 +1,24 @@
+import os
+from os.path import exists
+
+
+def cleanup() -> int:
+    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

utils/config.py

@@ -0,0 +1,40 @@
+# 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)

utils/console.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from rich.console import Console
 from rich.markdown import Markdown
 from rich.padding import Padding

utils/loader.py

@@ -1,9 +1,7 @@
-"""
+# 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.
 
-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.
 
-"""
 from itertools import cycle
 from shutil import get_terminal_size
 from threading import Thread

utils/subreddit.py

@@ -0,0 +1,32 @@
+from typing import List
+import json
+from os import getenv
+from utils.console import print_substep
+
+
+def get_subreddit_undone(submissions: List, subreddit):
+    """
+    recursively checks if the top submission in the list was already done.
+    """
+    with open("./video_creation/data/videos.json", "r") 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:
+            if getenv("ALLOW_NSFW").casefold() == "false":
+                print_substep("NSFW Post Detected. 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):
+
+    for video in done_videos:
+        if video["id"] == str(submission):
+            return True
+    return False

utils/videos.py

@@ -0,0 +1,23 @@
+import json
+from os import getenv
+
+from utils.console import print_step
+
+
+def check_done(
+    redditobj,
+):  # don't set this to be run anyplace that isn't subreddit.py bc of inspect stack
+    """params:
+    reddit_object: The Reddit Object you received in askreddit.py"""
+    with open("./video_creation/data/videos.json", "r") 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

utils/voice.py

@@ -0,0 +1,22 @@
+import re
+
+
+def sanitize_text(text):
+    """
+    Sanitizes the text for tts.
+       What gets removed:
+    - following characters`^_~@!&;#:-%“”‘"%*/{}[]()\|<>?=+`
+    - any http or https links
+    """
+
+    # 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)
+
+    # remove extra whitespace
+    return " ".join(result.split())

video_creation/background.py

@@ -1,51 +1,63 @@
-from random import randrange
+import random
-
+from os import listdir, environ
-from yt_dlp import YoutubeDL
-
 from pathlib import Path
+from random import randrange
+from pytube import YouTube
 from moviepy.video.io.ffmpeg_tools import ffmpeg_extract_subclip
 from moviepy.editor import VideoFileClip
 from utils.console import print_step, print_substep
 
 
 def get_start_and_end_times(video_length, length_of_clip):
-
     random_time = randrange(180, int(length_of_clip) - int(video_length))
     return random_time, random_time + video_length
 
-def download_background():
-    """Downloads the background video from youtube.
-
-    Shoutout to: bbswitzer (https://www.youtube.com/watch?v=n_Dv4JMiwK8)
-    """
 
-    if not Path("assets/mp4/background.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 Minecraft background video. This is fairly large but it's only done once."
+            "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": "assets/mp4/background.mp4",
-            "merge_output_format": "mp4",
-        }
-
-        with YoutubeDL(ydl_opts) as ydl:
-            ydl.download("https://www.youtube.com/watch?v=n_Dv4JMiwK8")
-
-        print_substep("Background video downloaded successfully!", style="bold green")
 
 
 def chop_background_video(video_length):
-    print_step("Finding a spot in the background video to chop...")
+    print_step("Finding a spot in the backgrounds video to chop...✂️")
-    background = VideoFileClip("assets/mp4/background.mp4")
+    choice = random.choice(listdir("assets/backgrounds"))
+    environ["background_credit"] = choice.split("-")[0]
+
+    background = VideoFileClip(f"assets/backgrounds/{choice}")
 
     start_time, end_time = get_start_and_end_times(video_length, background.duration)
     ffmpeg_extract_subclip(
-        "assets/mp4/background.mp4",
+        f"assets/backgrounds/{choice}",
         start_time,
         end_time,
-        targetname="assets/mp4/clip.mp4",
+        targetname="assets/temp/background.mp4",
     )
     print_substep("Background video chopped successfully!", style="bold green")
+    return True

video_creation/data/.gitignore

@@ -0,0 +1,2 @@
+videos.json
+ #todo add videos on github

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": "/"
+  }
+]

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": "/"
+  }
+]

video_creation/data/videos.json

@@ -0,0 +1 @@
+[]

video_creation/final_video.py

@@ -1,3 +1,9 @@
+#!/usr/bin/env python3
+import json
+import os
+import time
+from os.path import exists
+
 from moviepy.editor import (
     VideoFileClip,
     AudioFileClip,
@@ -7,29 +13,25 @@ from moviepy.editor import (
     CompositeAudioClip,
     CompositeVideoClip,
 )
-import reddit.subreddit 
+from moviepy.video.io import ffmpeg_tools
-import re
+from rich.console import Console
-from utils.console import print_step
-from dotenv import load_dotenv
-import os
-
-W, H = 1080, 1920
-
 
+from reddit import subreddit
+from utils.cleanup import cleanup
+from utils.console import print_step, print_substep
 
-def make_final_video(number_of_clips):
+console = Console()
 
-    # Calls opacity from the .env
+W, H = 1080, 1920
-    load_dotenv()
-    opacity = os.getenv('OPACITY')
 
-    print_step("Creating the final video...")
 
+def make_final_video(number_of_clips, length):
+    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)
@@ -38,30 +40,28 @@ def make_final_video(number_of_clips):
     # 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.append(AudioFileClip(f"assets/temp/mp3/{i}.mp3"))
-    audio_clips.insert(0, AudioFileClip(f"assets/mp3/title.mp3"))
+    audio_clips.insert(0, AudioFileClip(f"assets/temp/mp3/title.mp3"))
-    try:
-        audio_clips.insert(1, AudioFileClip(f"assets/mp3/posttext.mp3"))
-    except:
-        OSError()
     audio_concat = concatenate_audioclips(audio_clips)
     audio_composite = CompositeAudioClip([audio_concat])
 
-    # Gather all images
+    # Get sum of all clip lengths
+    total_length = sum([clip.duration for clip in audio_clips])
+    # round total_length to an integer
+    int_total_length = round(total_length)
+    # Output Length
+    console.log(f"[bold green] Video Will Be: {int_total_length} Seconds Long")
+
+    # add title to video
     image_clips = []
-    for i in range(0, number_of_clips):
+    # Gather all images
-        image_clips.append(
+    if (
-            ImageClip(f"assets/png/comment_{i}.png")
+            opacity is None or float(opacity) >= 1
-            .set_duration(audio_clips[i + 1].duration)
+    ):  # opacity not set or is set to one OR MORE
-            .set_position("center")
-            .resize(width=W - 100)
-            .set_opacity(float(opacity)),
-        )
-    if os.path.exists(f"assets/mp3/posttext.mp3"):
         image_clips.insert(
             0,
-            ImageClip(f"assets/png/title.png")
+            ImageClip(f"assets/temp/png/title.png")
-            .set_duration(audio_clips[0].duration + audio_clips[1].duration)
+            .set_duration(audio_clips[0].duration)
             .set_position("center")
             .resize(width=W - 100)
             .set_opacity(float(opacity)),
@@ -69,18 +69,89 @@ def make_final_video(number_of_clips):
     else:
         image_clips.insert(
             0,
-            ImageClip(f"assets/png/title.png")
+            ImageClip(f"assets/temp/png/title.png")
             .set_duration(audio_clips[0].duration)
             .set_position("center")
+            .resize(width=W - 100))
+
+    for i in range(0, number_of_clips):
+        if (
+                opacity is None or float(opacity) >= 1
+        ):  # opacity not set or is set to one OR MORE
+            image_clips.append(
+                ImageClip(f"assets/temp/png/comment_{i}.png")
+                .set_duration(audio_clips[i + 1].duration)
+                .set_position("center")
+                .resize(width=W - 100),
+            )
+        else:
+            image_clips.append(
+                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)),
             )
+
+    # 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])
-    filename = (re.sub('[?\"%*:|<>]', '', ("assets/" + reddit.subreddit.submission.title + ".mp4")))
+
-    final.write_videofile(filename, fps=30, audio_codec="aac", audio_bitrate="192k")
+    def get_video_title() -> str:
-    for i in range(0, number_of_clips):
+        title = os.getenv("VIDEO_TITLE") or "final_video"
-        pass
+        if len(title) <= 35:
+            return title
+        else:
+            return title[0:30] + "..."
+
+    filename = f"{get_video_title()}.mp4"
+
+    def save_data():
+        with open("./video_creation/data/videos.json", "r+") as raw_vids:
+            done_vids = json.load(raw_vids)
+            if str(subreddit.submission.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": str(os.getenv("VIDEO_ID")),
+                "time": str(int(time.time())),
+                "background_credit": str(os.getenv("background_credit")),
+                "reddit_title": str(os.getenv("VIDEO_TITLE")),
+                "filename": filename,
+            }
+            done_vids.append(payload)
+            raw_vids.seek(0)
+            json.dump(done_vids, raw_vids, ensure_ascii=False, indent=4)
+
+    save_data()
+    if not exists("./results"):
+        print_substep("the results folder didn't exist so I made it")
+        os.mkdir("./results")
+
+    final.write_videofile(
+        "assets/temp/temp.mp4", fps=30, audio_codec="aac", audio_bitrate="192k"
+    )
+    ffmpeg_tools.ffmpeg_extract_subclip(
+        "assets/temp/temp.mp4", 0, length, targetname=f"results/{filename}"
+    )
+    # os.remove("assets/temp/temp.mp4")
+
+    print_step("Removing temporary files 🗑")
+    cleanups = cleanup()
+    print_substep(f"Removed {cleanups} temporary files 🗑")
+    print_substep(f"See result in the results folder!")
+
+    print_step(
+        f"Reddit title: {os.getenv('VIDEO_TITLE')} \n Background Credit: {os.getenv('background_credit')}"
+    )

video_creation/screenshot_downloader.py

@@ -1,21 +1,30 @@
-from playwright.sync_api import sync_playwright, ViewportSize
+import json
+from os import getenv
 from pathlib import Path
+
+from playwright.async_api import async_playwright
+from playwright.sync_api import sync_playwright, ViewportSize
 from rich.progress import track
+
 from utils.console import print_step, print_substep
 import json
+from rich.console import Console
 
+console = Console()
 
-def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
+storymode = False
-    """Downloads screenshots of reddit posts as they are seen on the web.
 
+
+def download_screenshots_of_reddit_posts(reddit_object, screenshot_num):
+    """Downloads screenshots of reddit posts as they are seen on the web.
     Args:
         reddit_object: The Reddit Object you received in askreddit.py
         screenshot_num: The number of screenshots you want to download.
     """
-    print_step("Downloading Screenshots of Reddit Posts 📷")
+    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...")
@@ -23,11 +32,12 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
         browser = p.chromium.launch()
         context = browser.new_context()
 
-        if theme.casefold() == "dark":
+        if getenv("THEME").upper() == "DARK":
-            cookie_file = open('video_creation/cookies.json')
+            cookie_file = open("./video_creation/data/cookie-dark-mode.json")
+        else:
+            cookie_file = open("./video_creation/data/cookie-light-mode.json")
         cookies = json.load(cookie_file)
-            context.add_cookies(cookies)
+        context.add_cookies(cookies)  # load preference cookies
-
         # Get the thread screenshot
         page = context.new_page()
         page.goto(reddit_object["thread_url"])
@@ -37,11 +47,18 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
 
             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-test-id="post-content"]').screenshot(
-            path="assets/png/title.png"
+            path="assets/temp/png/title.png"
         )
-
+        if storymode:
+            page.locator('[data-click-id="text"]').screenshot(
+                path="assets/temp/png/story_content.png"
+            )
+        else:
             for idx, comment in track(
                 enumerate(reddit_object["comments"]), "Downloading screenshots..."
             ):
@@ -55,8 +72,6 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
 
                 page.goto(f'https://reddit.com{comment["comment_url"]}')
                 page.locator(f"#t1_{comment['comment_id']}").screenshot(
-                path=f"assets/png/comment_{idx}.png"
+                    path=f"assets/temp/png/comment_{idx}.png"
                 )
-
+        print_substep("Screenshots downloaded Successfully.", style="bold green")
-        print_substep("Screenshots downloaded Successfully.",
-                      style="bold green")

video_creation/voices.py

@@ -1,13 +1,25 @@
-from gtts import gTTS
+#!/usr/bin/env python3
+from os import getenv
 from pathlib import Path
-from mutagen.mp3 import MP3
+
-from utils.console import print_step, print_substep
+import sox
+from mutagen import MutagenError
+from mutagen.mp3 import MP3, HeaderNotFoundError
+from rich.console import Console
 from rich.progress import track
 
+from TTS.swapper import TTS
+
+console = Console()
+
+from utils.console import print_step, print_substep
+from utils.voice import sanitize_text
+
+VIDEO_LENGTH: int = 40  # secs
+
 
 def save_text_to_mp3(reddit_obj):
     """Saves Text to MP3 files.
-
     Args:
         reddit_obj : The reddit object you received from the reddit API in the askreddit.py file.
     """
@@ -15,30 +27,51 @@ def save_text_to_mp3(reddit_obj):
     length = 0
 
     # Create a folder for the mp3 files.
-    Path("assets/mp3").mkdir(parents=True, exist_ok=True)
+    Path("assets/temp/mp3").mkdir(parents=True, exist_ok=True)
-
+    TextToSpeech = TTS()
-    tts = gTTS(text=reddit_obj["thread_title"], lang="en", slow=False)
+    TextToSpeech.tts(
-    tts.save(f"assets/mp3/title.mp3")
+        sanitize_text(reddit_obj["thread_title"]),
-    length += MP3(f"assets/mp3/title.mp3").info.length
+        filename=f"assets/temp/mp3/title.mp3",
-
+        random_speaker=False,
+    )
     try:
-        Path(f"assets/mp3/posttext.mp3").unlink()
+        length += MP3(f"assets/temp/mp3/title.mp3").info.length
-    except OSError as e:
+    except HeaderNotFoundError:  # note to self AudioFileClip
-        pass
+        length += sox.file_info.duration(f"assets/temp/mp3/title.mp3")
-
+    if getenv("STORYMODE").casefold() == "true":
-    if reddit_obj["thread_post"] != "":
+        TextToSpeech.tts(
-        tts = gTTS(text=reddit_obj["thread_post"], lang="en", slow=False)
+            sanitize_text(reddit_obj["thread_content"]),
-        tts.save(f"assets/mp3/posttext.mp3")
+            filename=f"assets/temp/mp3/story_content.mp3",
-        length += MP3(f"assets/mp3/posttext.mp3").info.length
+            random_speaker=False,
-
+        )
-    for idx, comment in track(enumerate(reddit_obj["comments"]), "Saving..."):
+        # 'story_content'
-        # ! Stop creating mp3 files if the length is greater than 50 seconds. This can be longer, but this is just a good starting point
+    com = 0
-        if length > 50:
+    for comment in track((reddit_obj["comments"]), "Saving..."):
+        # ! Stop creating mp3 files if the length is greater than VIDEO_LENGTH seconds. This can be longer, but this is just a good_voices starting point
+        if length > VIDEO_LENGTH:
             break
-        tts = gTTS(text=comment["comment_body"], 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")
+        TextToSpeech.tts(
-    # ! Return the index so we know how many screenshots of comments we need to make.
+            sanitize_text(comment["comment_body"]),
-    return length, idx
+            filename=f"assets/temp/mp3/{com}.mp3",
+            random_speaker=False,
+        )
+        try:
+            length += MP3(f"assets/temp/mp3/{com}.mp3").info.length
+            com += 1
+        except (HeaderNotFoundError, MutagenError, Exception):
+            try:
+                length += sox.file_info.duration(f"assets/temp/mp3/{com}.mp3")
+                com += 1
+            except (OSError, IOError):
+                print(
+                    "would have removed"
+                    f"assets/temp/mp3/{com}.mp3"
+                    f"assets/temp/png/comment_{com}.png"
+                )
+                # remove(f"assets/temp/mp3/{com}.mp3")
+                # remove(f"assets/temp/png/comment_{com}.png")# todo might cause odd un-syncing
+
+    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, com