Merge branch 'develop' into ux-changes

.gitignore

@@ -1,11 +1,165 @@
-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

.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

@@ -38,8 +38,7 @@ Additionally, there is a [Discord Server](https://discord.gg/swqtb7AsNQ) for any
 ## I Want To Contribute
 
 ### Reporting Bugs
-
+<details><summary><h4>Before Submitting a Bug Report</h4></summary>
-#### Before Submitting a Bug Report
 
 A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
@@ -53,8 +52,8 @@ A good bug report shouldn't leave others needing to chase you up for more inform
   - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
   - Your input and the output
   - Is the issue reproducable? Does it exist in previous versions?
-
+</details>
-#### How Do I Submit a Good Bug Report?
+<details><summary><h4>How Do I Submit a Good Bug Report?</h4></summary>
 
 We use GitHub issues to track bugs and errors. If you run into an issue with the project:
 
@@ -68,12 +67,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 recieve 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 +90,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

@@ -32,9 +32,8 @@ These videos on TikTok, YouTube and Instagram get MILLIONS of views across all p
 ## Installation 👩‍💻
 
 1. Clone this repository
-
 2. Run `pip3 install -r requirements.txt`
-3. Run `playwright install` and `playwright install-deps`.
+3. Run `python3 -m playwright install` and `python3 -m playwright install-deps`.
 4. 
 	4a **Automatic Install**: Run `python3 main.py` and type 'yes' to activate the setup assistant.
 

build.sh

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

main.py

@@ -1,7 +1,6 @@
+#!/usr/bin/env python3
 # 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 reddit.subreddit import get_subreddit_threads
@@ -9,12 +8,10 @@ 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 dotenv import load_dotenv
+import os
 
 console = Console()
-from dotenv import load_dotenv
-import os, time, shutil
 
 configured = True
 REQUIRED_VALUES = [
@@ -75,7 +72,7 @@ if not os.path.exists(".env"):
     console.log("[red] Your .env file is invalid, or was never created. Standby.")
 
 for val in REQUIRED_VALUES:
-    #print(os.getenv(val))
+    # 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
@@ -102,9 +99,9 @@ for val in REQUIRED_VALUES:
             exit()
 try:
     float(os.getenv("OPACITY"))
-except:
+except ValueError:
     console.log(
-        f"[red]Please ensure that OPACITY is set between 0 and 1 in your .env file"
+        "[red]Please ensure that OPACITY is set between 0 and 1 in your .env file"
     )
     configured = False
     exit()

reddit/subreddit.py

@@ -1,9 +1,13 @@
+#!/usr/bin/env python3
 from rich.console import Console
-from utils.console import print_markdown, print_step, print_substep
+from utils.console import print_step, print_substep
 from dotenv import load_dotenv
+import os
+import random
+import praw
+import re
 
 console = Console()
-import os, random, praw, re
 
 
 def get_subreddit_threads():
@@ -38,7 +42,7 @@ def get_subreddit_threads():
     if not os.getenv("RANDOM_THREAD") or os.getenv("RANDOM_THREAD") == "no":
         print_substep("Insert the full thread link:", style="bold green")
         thread_link = input()
-        print_step(f"Getting the inserted thread...")
+        print_step("Getting the inserted thread...")
         submission = reddit.submission(url=thread_link)
     else:
         # Otherwise, picks a random thread from the inserted subreddit
@@ -48,7 +52,11 @@ def get_subreddit_threads():
             # ! Prompt the user to enter a subreddit
             try:
                 subreddit = reddit.subreddit(
-                    re.sub(r"r\/", "",input("What subreddit would you like to pull from? "))
+                    re.sub(
+                        r"r\/",
+                        "",
+                        input("What subreddit would you like to pull from? "),
+                    )
                 )
             except ValueError:
                 subreddit = reddit.subreddit("askreddit")
@@ -82,7 +90,7 @@ def get_subreddit_threads():
                     }
                 )
 
-    except AttributeError as e:
+    except AttributeError:
         pass
     print_substep("Received AskReddit threads successfully.", style="bold green")
 

run.sh

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

setup.py

@@ -1,55 +1,98 @@
-"""
+#!/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 = "",
-	exit()
+    check_type=False,
+    match: str = "",
+    err_message: str = "",
+    nmin=None,
+    nmax=None,
+    oob_error="",
+):
+    match = re.compile(match + "$")
+    while True:
+        user_input = input(message + "\n> ").strip()
+        if re.match(match, user_input) is not None:
+            if check_type is not False:
+                try:
+                    user_input = check_type(user_input)
+                    if nmin is not None and user_input < nmin:
+                        console.log("[red]" + oob_error)  # Input too low failstate
+                        continue
+                    if nmax is not None and user_input > nmax:
+                        console.log("[red]" + oob_error)  # Input too high
+                        continue
+                    break  # Successful type conversion and number in bounds
+                except ValueError:
+                    console.log("[red]" + err_message)  # Type conversion failed
+                    continue
+            if (
+                nmin is not None and len(user_input) < nmin
+            ):  # Check if string is long enough
+                console.log("[red]" + oob_error)
+                continue
+            if (
+                nmax is not None and len(user_input) > nmax
+            ):  # Check if string is not too long
+                console.log("[red]" + oob_error)
+                continue
+            break
+        console.log("[red]" + err_message)
+
+    return user_input
+
+
+if os.path.isfile(".setup-done-before"):
+    console.log(
+        "[red]Setup was already completed! Please make sure you have to run this script again. If that is such, delete the file .setup-done-before"
+    )
+    exit()
 
 # These lines ensure the user:
 # - knows they are in setup mode
 # - knows that they are about to erase any other setup files/data.
 
 print_step("Setup Assistant")
-
 print_markdown(
-	"### You're in the setup wizard. Ensure you're supposed to be here, then type yes to continue. If you're not sure, type no to quit."
+    "### 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...")
-	console.print("[red]Exiting...")
+    exit()
-	time.sleep(0.5)
+# This code is inaccessible if the prior check fails, and thus an else statement is unnecessary
-	exit()
+
-else:
-	# 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")
-	overwriteSettings = input("Are you sure you want to continue? > ").casefold()
-	if overwriteSettings != "yes":
-		console.print("[red]Abort mission! Exiting...")
-		time.sleep(0.5)
-		exit()
-	else:
-		# Once they confirm, move on with the script.
-		console.print("[bold green]Alright! Let's get started!")
-		time.sleep(1)
 
+# Again, let them know they are about to erase all other setup data.
+console.print(
+    "[bold red] This will overwrite your current settings. Are you sure you want to continue? [bold green]yes/no"
+)
+
+
+if input("Are you sure you want to continue? > ").strip().casefold() != "yes":
+    console.print("[red]Abort mission! Exiting...")
+    exit()
+# This is once again inaccessible if the prior checks fail
+# Once they confirm, move on with the script.
+console.print("[bold green]Alright! Let's get started!")
+
+print("\n")
 console.log("Ensure you have the following ready to enter:")
 console.log("[bold green]Reddit Client ID")
 console.log("[bold green]Reddit Client Secret")
@@ -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."
-	console.print("[red]I don't understand that.")
+)
-	console.print("[red]Exiting...")
+print()
-	exit()
-else:
-	console.print("[bold green]Alright! Let's get started!")
-	time.sleep(1)
 
-"""
 
-Begin the setup process.
+if input("Are you sure you have the credentials? > ").strip().casefold() != "yes":
+    console.print("[red]I don't understand that.")
+    console.print("[red]Exiting...")
+    exit()
 
-"""
+
+console.print("[bold green]Alright! Let's get started!")
+
+# Begin the setup process.
 
 console.log("Enter your credentials now.")
-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(
- # you can also put a while loop here, e.g. while VideoIsBeingMade == True: ...
+    "Client Secret > ",
-time.sleep(0.5)
+    False,
-console.log("Removing old .env file...")
+    "[-a-zA-Z0-9._~+/]+=*",
-os.remove(".env")
+    "That is somehow not a correct secret, try again.",
-time.sleep(0.5)
+    20,
-console.log("Creating new .env file...")
+    40,
-with open('.env', 'a') as f:
+    "The secret should be over 20 and under 40 characters, double check your input.",
-	f.write(f'REDDIT_CLIENT_ID="{cliID}"\n')
+)
-	time.sleep(0.5)
+user = handle_input(
-	f.write(f'REDDIT_CLIENT_SECRET="{cliSec}"\n')
+    "Username > ",
-	time.sleep(0.5)
+    False,
-	f.write(f'REDDIT_USERNAME="{user}"\n')
+    r"[_0-9a-zA-Z]+",
-	time.sleep(0.5)
+    "That is not a valid user",
-	f.write(f'REDDIT_PASSWORD="{passw}"\n')
+    3,
-	time.sleep(0.5)
+    20,
-	f.write(f'REDDIT_2FA="{twofactor}"\n')
+    "A username HAS to be between 3 and 20 characters",
-	time.sleep(0.5)
+)
-	f.write(f'THEME="{theme}"\n')
+passw = handle_input("Password > ", False, ".*", "", 8, None, "Password too short")
-	time.sleep(0.5)
+twofactor = handle_input(
-	f.write(f'SUBREDDIT="{subreddit}"\n')
+    "2fa Enabled? (yes/no) > ",
-	time.sleep(0.5)
+    False,
-	f.write(f'OPACITY="{opacity}"\n')
+    r"(yes)|(no)",
-
+    "You need to input either yes or no",
-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.")
+opacity = handle_input(
+    "Opacity? (range of 0-1) > ",
+    float,
+    ".*",
+    "You need to input a number between 0 and 1",
+    0,
+    1,
+    "Your number is not between 0 and 1",
+)
+subreddit = handle_input(
+    "Subreddit (without r/) > ",
+    False,
+    r"[_0-9a-zA-Z]+",
+    "This subreddit cannot exist, make sure you typed it in correctly and removed the r/ (or /r/).",
+    3,
+    20,
+    "A subreddit name HAS to be between 3 and 20 characters",
+)
+theme = handle_input(
+    "Theme? (light or dark) > ",
+    False,
+    r"(light)|(dark)",
+    "You need to input 'light' or 'dark'",
+)
+loader = Loader("Attempting to save your credentials...", "Done!").start()
+# you can also put a while loop here, e.g. while VideoIsBeingMade == True: ...
+console.log("Writing to the .env file...")
+with open(".env", "w") as f:
+    f.write(
+        f"""REDDIT_CLIENT_ID="{client_id}"
+REDDIT_CLIENT_SECRET="{client_sec}"
+REDDIT_USERNAME="{user}"
+REDDIT_PASSWORD="{passw}"
+REDDIT_2FA="{twofactor}"
+THEME="{theme}"
+SUBREDDIT="{subreddit}"
+OPACITY={opacity}
+"""
+    )
+
+with open(".setup-done-before", "w") as f:
+    f.write(
+        "This file blocks the setup assistant from running again. Delete this file to run setup again."
+    )
 
 loader.stop()
 
 console.log("[bold green]Setup Complete! Returning...")
 
 # Post-Setup: send message and try to run main.py again.
-os.system("python3 main.py")
+subprocess.call("python3 main.py", shell=True)

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,8 @@
-"""
 
-Okay, have to admit. This code is from StackOverflow. It's so efficient, that it's probably the best way to do it.
+# 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.
+# Although, it is edited to use less threads.
+
 
-"""
 from itertools import cycle
 from shutil import get_terminal_size
 from threading import Thread

video_creation/background.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from random import randrange
 
 from yt_dlp import YoutubeDL
@@ -13,6 +14,7 @@ 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.
 

video_creation/final_video.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from moviepy.editor import (
     VideoFileClip,
     AudioFileClip,
@@ -19,12 +20,11 @@ console = Console()
 W, H = 1080, 1920
 
 
-
 def make_final_video(number_of_clips):
 
     # Calls opacity from the .env
     load_dotenv()
-    opacity = os.getenv('OPACITY')
+    opacity = os.getenv("OPACITY")
 
     print_step("Creating the final video...")
 
@@ -42,9 +42,9 @@ def make_final_video(number_of_clips):
     audio_clips = []
     for i in range(0, number_of_clips):
         audio_clips.append(AudioFileClip(f"assets/mp3/{i}.mp3"))
-    audio_clips.insert(0, AudioFileClip(f"assets/mp3/title.mp3"))
+    audio_clips.insert(0, AudioFileClip("assets/mp3/title.mp3"))
     try:
-        audio_clips.insert(1, AudioFileClip(f"assets/mp3/posttext.mp3"))
+        audio_clips.insert(1, AudioFileClip("assets/mp3/posttext.mp3"))
     except:
         OSError()
     audio_concat = concatenate_audioclips(audio_clips)
@@ -65,30 +65,32 @@ def make_final_video(number_of_clips):
             .resize(width=W - 100)
             .set_opacity(float(opacity)),
         )
-    if os.path.exists(f"assets/mp3/posttext.mp3"):
+    if os.path.exists("assets/mp3/posttext.mp3"):
         image_clips.insert(
             0,
-            ImageClip(f"assets/png/title.png")
+            ImageClip("assets/png/title.png")
             .set_duration(audio_clips[0].duration + audio_clips[1].duration)
             .set_position("center")
             .resize(width=W - 100)
             .set_opacity(float(opacity)),
-            )
+        )
     else:
         image_clips.insert(
             0,
-            ImageClip(f"assets/png/title.png")
+            ImageClip("assets/png/title.png")
             .set_duration(audio_clips[0].duration)
             .set_position("center")
             .resize(width=W - 100)
             .set_opacity(float(opacity)),
-            )
+        )
     image_concat = concatenate_videoclips(image_clips).set_position(
         ("center", "center")
     )
     image_concat.audio = audio_composite
     final = CompositeVideoClip([background_clip, image_concat])
-    filename = (re.sub('[?\"%*:|<>]', '', ("assets/" + reddit.subreddit.submission.title + ".mp4")))
+    filename = re.sub(
+        '[?"%*:|<>]', "", ("assets/" + reddit.subreddit.submission.title + ".mp4")
+    )
     final.write_videofile(filename, fps=30, audio_codec="aac", audio_bitrate="192k")
     for i in range(0, number_of_clips):
         pass

video_creation/screenshot_downloader.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from playwright.sync_api import sync_playwright, ViewportSize
 from pathlib import Path
 from rich.progress import track
@@ -26,7 +27,7 @@ def download_screenshots_of_reddit_posts(reddit_object, screenshot_num, theme):
         context = browser.new_context()
 
         if theme.casefold() == "dark":
-            cookie_file = open('video_creation/cookies.json')
+            cookie_file = open("video_creation/cookies.json")
             cookies = json.load(cookie_file)
             context.add_cookies(cookies)
 

video_creation/voices.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from gtts import gTTS
 from pathlib import Path
 from mutagen.mp3 import MP3
@@ -5,6 +6,7 @@ from utils.console import print_step, print_substep
 from rich.progress import track
 from rich.console import Console
 console = Console()
+import re
 
 def save_text_to_mp3(reddit_obj):
     """Saves Text to MP3 files.
@@ -19,18 +21,18 @@ def save_text_to_mp3(reddit_obj):
     Path("assets/mp3").mkdir(parents=True, exist_ok=True)
 
     tts = gTTS(text=reddit_obj["thread_title"], lang="en", slow=False)
-    tts.save(f"assets/mp3/title.mp3")
+    tts.save("assets/mp3/title.mp3")
-    length += MP3(f"assets/mp3/title.mp3").info.length
+    length += MP3("assets/mp3/title.mp3").info.length
 
     try:
-        Path(f"assets/mp3/posttext.mp3").unlink()
+        Path("assets/mp3/posttext.mp3").unlink()
-    except OSError as e:
+    except OSError:
         pass
 
     if reddit_obj["thread_post"] != "":
         tts = gTTS(text=reddit_obj["thread_post"], lang="en", slow=False)
-        tts.save(f"assets/mp3/posttext.mp3")
+        tts.save("assets/mp3/posttext.mp3")
-        length += MP3(f"assets/mp3/posttext.mp3").info.length
+        length += MP3("assets/mp3/posttext.mp3").info.length
 
     for idx, comment in track(enumerate(reddit_obj["comments"])):
 
@@ -40,7 +42,9 @@ def save_text_to_mp3(reddit_obj):
         # ! Stop creating mp3 files if the length is greater than 50 seconds. This can be longer, but this is just a good starting point
         if length > 50:
             break
-        tts = gTTS(text=comment["comment_body"], lang="en", slow=False)
+        comment=comment["comment_body"]
+        text=re.sub('((http|https)\:\/\/)?[a-zA-Z0-9\.\/\?\:@\-_=#]+\.([a-zA-Z]){2,6}([a-zA-Z0-9\.\&\/\?\:@\-_=#])*', '', comment)
+        tts = gTTS(text, lang="en", slow=False)
         tts.save(f"assets/mp3/{idx}.mp3")
         length += MP3(f"assets/mp3/{idx}.mp3").info.length