Merge pull request #1 from ManimCommunity/master

Update from Upstream

Author: Aathish04

.travis.yml

@@ -39,6 +39,11 @@ jobs:
       language: sh
       python: 3.6
       env: PYVER="3.6.10"
+      before_install:
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -51,6 +56,11 @@ jobs:
       language: sh
       python: 3.7
       env: PYVER="3.7.7"
+      before_install:
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -63,6 +73,11 @@ jobs:
       language: sh
       python: 3.8
       env: PYVER="3.8.0" # Using Python 3.8.0 due to error with rich
+      before_install:
+        - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
+        - brew install ffmpeg
+        - brew cask install mactex
+        - eval "$(/usr/libexec/path_helper)"
       install:
         - pip3 install --upgrade pip
         - pip3 install -r ./.travis/travis-requirements.txt
@@ -80,15 +95,14 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
-      script: 
-        - python -m pytest
+      script:
+        - python -m pytest --skip_end_to_end -rs
 
     - os: windows
       language: sh
@@ -97,15 +111,14 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
-      script: 
-        - python -m pytest
+      script:
+        - python -m pytest --skip_end_to_end -rs
 
     - os: windows
       language: sh
@@ -114,18 +127,18 @@ jobs:
       install:
         - choco install python --version=$PYVER
         - export PATH="/c/$PYDIR:/c/$PYDIR/Scripts:$PATH"
-        - choco install ffmpeg
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --upgrade pip
         - python -m pip install --user -r ./.travis/travis-requirements.txt
         - python ./scripts/pycairoinstall.py
         - cmd.exe //c "RefreshEnv.cmd"
         - python -m pip install --user .
-      script: 
-        - python -m pytest
+      script:
+        - python -m pytest --skip_end_to_end -rs
 
 before_install:
   - if [ "$TRAVIS_OS_NAME" == "osx" ]; then chmod +x ./.travis/osx.sh; sh ./.travis/osx.sh; fi
+  - if [ "$TRAVIS_OS_NAME" == "linux" ]; then chmod +x ./.travis/linux.sh; sh ./.travis/linux.sh; fi
 
 branches:
   only:

.travis/linux.sh

@@ -0,0 +1,5 @@
+##### THIS IS FOR TRAVIS BUILDS, DO NOT RUN THIS ON YOUR COMPUTER! #####
+
+sudo apt update
+sudo apt install -y ffmpeg
+sudo apt-get -y install texlive texlive-latex-extra texlive-fonts-extra texlive-latex-recommended texlive-science texlive-fonts-extra tipa

.travis/osx.sh

@@ -3,10 +3,11 @@
 brew update
 brew install openssl readline
 brew outdated pyenv || brew upgrade pyenv
+brew install ffmpeg
 brew install pyenv-virtualenv
 pyenv install $PYVER
 export PYENV_VERSION=$PYVER
 export PATH="/Users/travis/.pyenv/shims:${PATH}"
 pyenv virtualenv venv
 source ~/.pyenv/versions/venv/bin/activate
-python --version
+python --version

.travis/travis-requirements.txt

@@ -5,10 +5,8 @@ Pillow
 progressbar
 scipy
 tqdm
-# opencv-python
-# pycairo
 pydub
 pygments
 pyreadline; sys_platform == 'win32'
 rich
-pytest
+pytest

CONTRIBUTING.md

@@ -4,6 +4,7 @@
 2. (For the maintainers of this repo) Label PRs appropriately.
 3. Link relevant issues.
 4. Ensure compatibility with the latest changes in the repo.
+5. After you've made your changes, please test them out thoroughly. If the repository has any example code or code exclusively used for testing, please test your changes against those. If you have added new features, consider writing and contributing to a test for that feature to ensure it works properly.
 
 ## Contributing to the Manim Community Fork - General instructions
 
@@ -33,6 +34,8 @@ As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributin
 
 4. After that, you can make your changes to the repo's files (the code is in the `manim` directory). Then, you can commit said changes.
 
+> As stated in the General Contribution Guidelines, make sure to test your changes against the example scenes in the `example_scenes` directory and test scenes in the `tests` directory, and add a new test in the `tests` directory for your new feature if you've made one.
+
 > Note: if your Pull Request doesn't change any of the actual code, please add `[skip ci]` to your commit message for Travis to ignore it.
 
 5. Finally, instead of  typing in `git push`, enter the command below.

README.md

@@ -19,18 +19,23 @@ Manim is an animation engine for explanatory math videos. It's used to create pr
     + [FFmpeg Installation](#ffmpeg-installation)
     + [SoX Installation](#sox-installation)
     + [LaTeX Installation](#latex-installation)
-  * [Linux](#linux)
+  * [Ubuntu/Debian](#ubuntudebian)
     + [Cairo Installation](#cairo-installation-1)
     + [FFmpeg Installation](#ffmpeg-installation-1)
     + [SoX Installation](#sox-installation-1)
     + [LaTeX Installation](#latex-installation-1)
     + [Additional Installation Steps](#additional-installation-steps)
-  * [Mac](#mac)
-    + [Homebrew Installation](#homebrew-installation)
+  * [Arch/Manjaro](#archmanjaro)
     + [Cairo Installation](#cairo-installation-2)
     + [FFmpeg Installation](#ffmpeg-installation-2)
     + [SoX Installation](#sox-installation-2)
     + [LaTeX Installation](#latex-installation-2)
+  * [Mac](#mac)
+    + [Homebrew Installation](#homebrew-installation)
+    + [Cairo Installation](#cairo-installation-3)
+    + [FFmpeg Installation](#ffmpeg-installation-3)
+    + [SoX Installation](#sox-installation-3)
+    + [LaTeX Installation](#latex-installation-3)
   * [Installing Manim-Community itself](#installing-manim-community-itself)
 - [Usage](#usage)
 - [Documentation](#documentation)
@@ -96,7 +101,7 @@ Before installing `manim-community`, there are some additional dependencies that
 <img style="width: 20vw;" src="./readme-assets/windows_miktex.png" />
 <br><br>
 
-### Linux
+### Ubuntu/Debian
 
 Before installing `manim-community`, there are some additional dependencies that you must have installed:
  - Cairo
@@ -123,12 +128,32 @@ sudo apt install texlive texlive-latex-extra texlive-fonts-extra texlive-latex-r
 > Note: this installation may take up a lot of space. The developers are working on providing a simpler, lighter LaTeX package for you to install
 2. You can check you did it right by running `latex`
 
-#### Additional Installation Steps
-- You must install additional codecs to play MP4 files:
+### Arch/Manjaro
+
+Before installing `manim-community`, there are some additional dependencies that you must have installed:
+ - Cairo
+ - FFmpeg
+ - Sox (optional, for sound)
+ - LaTeX (optional, for LaTeX)
+
+#### Cairo Installation
+1. Install the `cairo` package with your package manager: `sudo pacman -S cairo`
+
+#### FFmpeg Installation
+1. Install the `ffmpeg` package with your package manager: `sudo pacman -S ffmpeg`
+2. You can check you did it right by running `ffmpeg -version`
+
+#### SoX Installation
+1. Install the `sox` package with your package manager: `sudo pacman -S sox`
+2. You can check you did it right by running `sox`
+
+#### LaTeX Installation
+1. Install `texlive` with your package manager by running the following commands:
 ```
-sudo apt install libdvdnav4 libdvd-pkg gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly libdvd-pkg
-sudo apt install ubuntu-restricted-extras
+sudo pacman -S texlive-most
 ```
+> Note: this installation may take up a lot of space. The developers are working on providing a simpler, lighter LaTeX package for you to install
+2. You can check you did it right by running `latex`
 
 ### Mac
 

example_scenes/basic.py

@@ -106,7 +106,7 @@ def construct(self):
         )
         group = VGroup(example_text, example_tex)
         group.arrange(DOWN)
-        group.set_width(FRAME_WIDTH - 2 * LARGE_BUFF)
+        group.set_width(config['frame_width'] - 2 * LARGE_BUFF)
 
         self.play(Write(example_text))
         self.play(Write(example_tex))

example_scenes/customtex.py

@@ -12,16 +12,17 @@
 
 class ExampleFileScene(Scene):
     def construct(self):
-        text=TexMobject(r"\vv{vb}")
+        text = TexMobject(r"\vv{vb}")
         #text=TextMobject(r"$\vv{vb}$")
         self.play(Write(text))
 
+
 class ExampleClassScene(Scene):
     def construct(self):
-        tpl=TexTemplate()
+        tpl = TexTemplate()
         tpl.append_package(["esvect",["f"]])
         config.register_tex_template(tpl)
 
         #text=TextMobject(r"$\vv{vb}$")
-        text=TexMobject(r"\vv{vb}")
+        text = TexMobject(r"\vv{vb}")
         self.play(Write(text))

manim/__init__.py

@@ -1,4 +1,7 @@
 #!/usr/bin/env python
+
+# Importing config should be the first thing since other modules use it
+from .config import config
 from .constants import *
 
 from .animation.animation import *