chore(gh-pages): remove hidden files

* chore(docs): use RTD

* chore(ci): remove pages deployment

.github/workflows/python-publish.yml

@@ -1,55 +0,0 @@
-# From: https://github.com/pypa/cibuildwheel
-name: Upload Python Package
-
-on:
-  push:
-
-  release:
-    types: [published]
-
-jobs:
-  build_wheels:
-    name: Build wheels on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-
-    steps:
-      - uses: actions/checkout@v2
-
-      # Used to host cibuildwheel
-      - uses: actions/setup-python@v2
-
-      - name: Install deps
-        run: sudo apt-get install libsdl-pango-dev
-
-      - name: Install packages
-        run: python -m pip install -U manim tqdm
-
-      - name: Install cibuildwheel
-        run: python -m pip install -U setuptools wheel pip
-
-      - name: Build wheels
-        run: python setup.py sdist
-
-      - uses: actions/upload-artifact@v2
-        with:
-          name: dist
-          path: dist/*.tar.*
-
-  release:
-    name: Release
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-    runs-on: ubuntu-latest
-    needs: [ build_wheels ]
-    steps:
-      - uses: actions/download-artifact@v2
-        with:
-          name: dist
-          path: dist/
-      - name: Upload to PyPI
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test_examples.yml

@@ -1,100 +0,0 @@
-on:
-  pull_request:
-    paths:
-      - '**.py'
-  workflow_dispatch:
-
-name: Test Examples
-
-jobs:
-  build-examples:
-    strategy:
-      matrix:
-        manim: [manim, manimgl]
-        os: [macos-latest, ubuntu-latest, windows-latest]
-        pyversion: ['3.7', '3.8', '3.9', '3.10']
-        exclude:
-        # excludes manimgl on Windows because if throws errors
-        # related to OpenGL, which seems hard to fix:
-        # Your graphics drivers do not support OpenGL 2.0.
-        - os: windows-latest
-          manim: manimgl
-        # manimgl actually requires Python >= 3.8, see:
-        # https://github.com/3b1b/manim/issues/1808
-        - manim: manimgl
-          pyversion: '3.7'
-        # We only test Python 3.10 on Windows and MacOS
-        - os: windows-latest
-          pyversion: '3.7'
-        - os: windows-latest
-          pyversion: '3.8'
-        - os: windows-latest
-          pyversion: '3.9'
-        - os: macos-latest
-          pyversion: '3.7'
-        - os: macos-latest
-          pyversion: '3.8'
-        - os: macos-latest
-          pyversion: '3.9'
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-      - name: Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.pyversion }}
-      - name: Append to Path on MacOS and Ubuntu
-        if: matrix.os == 'macos-latest' || matrix.os == 'ubuntu-latest'
-        run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
-      - name: Append to Path on Windows
-        if: matrix.os == 'windows-latest'
-        run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
-      - name: Install MacOS dependencies (manim only)
-        if: matrix.os == 'macos-latest' && matrix.manim == 'manim'
-        run: brew install py3cairo
-      - name: Install MacOS dependencies
-        if: matrix.os == 'macos-latest'
-        run: brew install ffmpeg
-      - name: Install Ubuntu dependencies
-        if: matrix.os == 'ubuntu-latest'
-        run: sudo apt install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev xvfb
-      - name: Install Windows dependencies
-        if: matrix.os == 'windows-latest'
-        run: choco install ffmpeg
-      - name: Install manim on MacOs
-        if: matrix.manim == 'manim' && matrix.os == 'macos-latest'
-        run: pip3 install --user manim
-      - name: Install manim on Ubuntu and Windows
-        if: matrix.manim == 'manim' && (matrix.os == 'ubuntu-latest' || matrix.os == 'windows-latest')
-        run: python -m pip install --user manim
-      - name: Install manimgl on MacOs
-        if: matrix.manim == 'manimgl' && matrix.os == 'macos-latest'
-        run: pip3 install --user manimgl
-      - name: Install manimgl on Ubuntu and Windows
-        if: matrix.manim == 'manimgl' && matrix.os != 'macos-latest'
-        run: python -m pip install --user manimgl
-      - name: Install manim-slides on MacOS
-        if: matrix.os == 'macos-latest'
-        run: pip3 install --user .
-      - name: Install manim-slides on Ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        run: xvfb-run -a -s "-screen 0 1400x900x24" python -m pip install --user .
-      - name: Install manim-slides on Windows
-        if: matrix.os == 'windows-latest'
-        run: pip3 install -e .
-      - name: Build slides with manim
-        if: matrix.manim == 'manim'
-        run: python -m manim -ql example.py Example ThreeDExample
-      - name: Build slides with manimgl on Ubuntu
-        if: matrix.manim == 'manimgl' && matrix.os == 'ubuntu-latest'
-        run: xvfb-run -a -s "-screen 0 1400x900x24" manim-render -l example.py Example ThreeDExample
-      - name: Build slides with manimgl on MacOS or Windows
-        if: matrix.manim == 'manimgl' && (matrix.os == 'macos-latest' || matrix.os == 'windows-latest')
-        run: manimgl -l example.py Example ThreeDExample
-      - name: Test slides on Ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        run: xvfb-run -a -s "-screen 0 1400x900x24" manim-slides Example ThreeDExample --skip-all
-      - name: Test slides on MacOS or Windows
-        if: matrix.os == 'macos-latest' || matrix.os == 'windows-latest'
-        run: manim-slides Example ThreeDExample --skip-all

.gitignore

@@ -1,19 +0,0 @@
-__pycache__/
-/env
-/tests
-/build
-/dist
-*.egg-info/
-
-/media
-/presentation
-
-/.vscode
-
-slides/
-
-.manim-slides.json
-
-videos/
-
-images/

.pre-commit-config.yaml

@@ -1,17 +0,0 @@
-repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 22.6.0
-    hooks:
-    -   id: black
--   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--profile", "black"]

CNAME

@@ -0,0 +1 @@
+manim-slides.readthedocs.io

LICENSE.md

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,143 +1,4 @@
-[![Latest Release][pypi-version-badge]][pypi-version-url]
-[![Python version][pypi-python-version-badge]][pypi-version-url]
-![PyPI - Downloads](https://img.shields.io/pypi/dm/manim-slides)
-# Manim Slides
+# GitHub Pages branch
 
-Tool for live presentations using either [manim-community](https://www.manim.community/) or [manimgl](https://3b1b.github.io/manim/). `manim-slides` will automatically detect the one you are using!
-
-> **_NOTE:_**  This project extends the work of [`manim-presentation`](https://github.com/galatolofederico/manim-presentation), with a lot more features!
-
-## Install
-
-```
-pip install manim-slides
-```
-
-## Usage
-
-Use the class `Slide` as your scenes base class:
-```python
-from manim_slides import Slide
-
-class Example(Slide):
-    def construct(self):
-        ...
-```
-
-call `self.pause()` when you want to pause the playback and wait for an input to continue (check the keybindings).
-
-Wrap a series of animations between `self.start_loop()` and `self.stop_loop()` when you want to loop them (until input to continue):
-```python
-from manim import *
-# or: from manimlib import *
-from manim_slides import Slide
-
-class Example(Slide):
-    def construct(self):
-        circle = Circle(radius=3, color=BLUE)
-        dot = Dot()
-
-        self.play(GrowFromCenter(circle))
-        self.pause()
-
-        self.start_loop()
-        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
-
-        self.play(dot.animate.move_to(ORIGIN))
-        self.pause()
-
-        self.wait()
-```
-
-You **must** end your `Slide` with a `self.play(...)` or a `self.wait(..)`.
-
-To start the presentation using `Scene1`, `Scene2` and so on simply run:
-```
-manim-slides Scene1 Scene2...
-```
-
-##  Keybindings
-
-Default keybindings to control the presentation:
-
-|  Keybinding |          Action          |
-|:-----------:|:------------------------:|
-| Right Arrow |    Continue/Next Slide   |
-|  Left Arrow |      Previous Slide      |
-|      R      | Re-Animate Current Slide |
-|      V      |   Reverse Current Slide  |
-|   Spacebar  |        Play/Pause        |
-|      Q      |           Quit           |
-
-
-You can run the **configuration wizard** with:
-
-```
-manim-slides wizard
-```
-
-Alternatively you can specify different keybindings creating a file named `.manim-slides.json` with the keys: `QUIT` `CONTINUE` `BACK` `REVERSE` `REWIND` and `PLAY_PAUSE`.
-
-A default file can be created with:
-```
-manim-slides init
-```
-
-> **_NOTE:_**  `manim-slides` uses `cv2.waitKeyEx()` to wait for keypresses, and directly registers the key code.
-
-## Run Example
-
-Clone this repository:
-```
-git clone https://github.com/jeertmans/manim-slides.git
-cd manim-slides
-```
-
-Install `manim` and `manim-slides`:
-```
-pip install manim manim-slides
-# or
-pip install manimgl manim-slides
-```
-
-Render the example scene:
-```
-manim -qh example.py Example
-# or
-manimgl --hd example.py Example
-```
-
-Run the presentation
-```
-manim-slides Example
-```
-
-Below is a small recording of me playing with the slides back and forth.
-
-![](https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/example.gif)
-
-
-## Comparison with original `manim-presentation`
-
-Here are a few things that I implemented (or that I'm planning to implement) on top of the original work:
-
-- [x] Allowing multiple keys to control one action (useful when you use a laser pointer)
-- [x] More robust config files checking
-- [x] Dependencies are installed with the package
-- [x] Only one cli (to rule them all)
-- [x] User can easily generate dummy config file
-- [x] Config file path can be manually set
-- [x] Play animation in reverse [#9](https://github.com/galatolofederico/manim-presentation/issues/9)
-- [x] Handle 3D scenes out of the box
-- [x] Support for both `manim` and `manimgl` modules
-- [ ] Generate docs online
-- [x] Fix the quality problem on Windows platforms with `fullscreen` flag
-
-## Contributions and license
-
-The code is released as Free Software under the [GNU/GPLv3](https://choosealicense.com/licenses/gpl-3.0/) license. Copying, adapting and republishing it is not only consent but also encouraged.
-
-[pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides
-[pypi-version-url]: https://pypi.org/project/manim-slides/
-[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/manim-slides
+This branch is kept to keep the https://jeertmans.github.io/manim-slides
+link alive, and we redirect to Read The Docs.

example.py

@@ -1,127 +0,0 @@
-import sys
-
-if "manim" in sys.modules:
-    from manim import *
-
-    MANIMGL = False
-elif "manimlib" in sys.modules:
-    from manimlib import *
-
-    MANIMGL = True
-else:
-    raise ImportError("This script must be run with either `manim` or `manimgl`")
-
-from manim_slides import Slide, ThreeDSlide
-
-
-class Example(Slide):
-    def construct(self):
-        circle = Circle(radius=3, color=BLUE)
-        dot = Dot()
-
-        self.play(GrowFromCenter(circle))
-        self.pause()
-
-        self.start_loop()
-        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
-
-        self.play(dot.animate.move_to(ORIGIN))
-        self.pause()
-
-        self.play(dot.animate.move_to(RIGHT * 3))
-        self.pause()
-
-        self.start_loop()
-        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
-
-        # Each slide MUST end with an animation (a self.wait is considered an animation)
-        self.play(dot.animate.move_to(ORIGIN))
-
-
-# For ThreeDExample, things are different
-
-if not MANIMGL:
-
-    class ThreeDExample(ThreeDSlide):
-        def construct(self):
-            axes = ThreeDAxes()
-            circle = Circle(radius=3, color=BLUE)
-            dot = Dot(color=RED)
-
-            self.add(axes)
-
-            self.set_camera_orientation(phi=75 * DEGREES, theta=30 * DEGREES)
-
-            self.play(GrowFromCenter(circle))
-            self.begin_ambient_camera_rotation(rate=75 * DEGREES / 4)
-
-            self.pause()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
-            self.end_loop()
-
-            self.stop_ambient_camera_rotation()
-            self.move_camera(phi=75 * DEGREES, theta=30 * DEGREES)
-
-            self.play(dot.animate.move_to(ORIGIN))
-            self.pause()
-
-            self.play(dot.animate.move_to(RIGHT * 3))
-            self.pause()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-            self.end_loop()
-
-            # Each slide MUST end with an animation (a self.wait is considered an animation)
-            self.play(dot.animate.move_to(ORIGIN))
-
-else:
-    # WARNING: 3b1b's manim change how ThreeDScene work,
-    # this is why things have to be managed differently.
-    class ThreeDExample(Slide):
-        CONFIG = {
-            "camera_class": ThreeDCamera,
-        }
-
-        def construct(self):
-            axes = ThreeDAxes()
-            circle = Circle(radius=3, color=BLUE)
-            dot = Dot(color=RED)
-
-            self.add(axes)
-
-            frame = self.camera.frame
-            frame.set_euler_angles(
-                theta=30 * DEGREES,
-                phi=75 * DEGREES,
-                gamma=0,
-            )
-
-            self.play(GrowFromCenter(circle))
-            updater = lambda m, dt: m.increment_theta((75 * DEGREES / 4) * dt)
-            frame.add_updater(updater)
-
-            self.pause()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
-            self.end_loop()
-
-            frame.remove_updater(updater)
-            self.play(frame.animate.set_theta(30 * DEGREES))
-            self.play(dot.animate.move_to(ORIGIN))
-            self.pause()
-
-            self.play(dot.animate.move_to(RIGHT * 3))
-            self.pause()
-
-            self.start_loop()
-            self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-            self.end_loop()
-
-            # Each slide MUST end with an animation (a self.wait is considered an animation)
-            self.play(dot.animate.move_to(ORIGIN))

manim_slides/__init__.py

@@ -1,2 +0,0 @@
-from .__version__ import __version__
-from .slide import Slide, ThreeDSlide

manim_slides/__version__.py

@@ -1 +0,0 @@
-__version__ = "3.2.3"

manim_slides/commons.py

@@ -1,28 +0,0 @@
-import click
-
-from .defaults import CONFIG_PATH
-
-
-def config_path_option(function):
-    return click.option(
-        "-c",
-        "--config",
-        "config_path",
-        default=CONFIG_PATH,
-        type=click.Path(dir_okay=False),
-        help="Set path to configuration file.",
-    )(function)
-
-
-def config_options(function):
-    function = config_path_option(function)
-    function = click.option(
-        "-f", "--force", is_flag=True, help="Overwrite any existing configuration file."
-    )(function)
-    function = click.option(
-        "-m",
-        "--merge",
-        is_flag=True,
-        help="Merge any existing configuration file with the new configuration.",
-    )(function)
-    return function

manim_slides/config.py

@@ -1,49 +0,0 @@
-from typing import Optional, Set
-
-from pydantic import BaseModel, root_validator, validator
-
-from .defaults import LEFT_ARROW_KEY_CODE, RIGHT_ARROW_KEY_CODE
-
-
-class Key(BaseModel):
-    ids: Set[int]
-    name: Optional[str] = None
-
-    @validator("ids", each_item=True)
-    def id_is_posint(cls, v: int):
-        if v < 0:
-            raise ValueError("Key ids cannot be negative integers")
-        return v
-
-    def match(self, key_id: int):
-        return key_id in self.ids
-
-
-class Config(BaseModel):
-    QUIT: Key = Key(ids=[ord("q")], name="QUIT")
-    CONTINUE: Key = Key(ids=[RIGHT_ARROW_KEY_CODE], name="CONTINUE / NEXT")
-    BACK: Key = Key(ids=[LEFT_ARROW_KEY_CODE], name="BACK")
-    REVERSE: Key = Key(ids=[ord("v")], name="REVERSE")
-    REWIND: Key = Key(ids=[ord("r")], name="REWIND")
-    PLAY_PAUSE: Key = Key(ids=[32], name="PLAY / PAUSE")
-
-    @root_validator
-    def ids_are_unique_across_keys(cls, values):
-        ids = set()
-
-        for key in values.values():
-            if len(ids.intersection(key.ids)) != 0:
-                raise ValueError(
-                    "Two or more keys share a common key code: please make sure each key has distinc key codes"
-                )
-            ids.update(key.ids)
-
-        return values
-
-    def merge_with(self, other: "Config") -> "Config":
-        for key_name, key in self:
-            other_key = getattr(other, key_name)
-            key.ids.update(other_key.ids)
-            key.name = other_key.name or key.name
-
-        return self

manim_slides/defaults.py

@@ -1,11 +0,0 @@
-import platform
-
-FOLDER_PATH: str = "./slides"
-CONFIG_PATH: str = ".manim-slides.json"
-
-if platform.system() == "Windows":
-    RIGHT_ARROW_KEY_CODE = 2555904
-    LEFT_ARROW_KEY_CODE = 2424832
-else:
-    RIGHT_ARROW_KEY_CODE = 65363
-    LEFT_ARROW_KEY_CODE = 65361

manim_slides/main.py

@@ -1,22 +0,0 @@
-import click
-from click_default_group import DefaultGroup
-
-from . import __version__
-from .present import list_scenes, present
-from .wizard import init, wizard
-
-
-@click.group(cls=DefaultGroup, default="present", default_if_no_args=True)
-@click.version_option(__version__, "-v", "--version")
-@click.help_option("-h", "--help")
-def cli():
-    pass
-
-
-cli.add_command(list_scenes)
-cli.add_command(present)
-cli.add_command(wizard)
-cli.add_command(init)
-
-if __name__ == "__main__":
-    cli()

manim_slides/manim.py

@@ -1,45 +0,0 @@
-import sys
-from importlib.util import find_spec
-
-MANIM_PACKAGE_NAME = "manim"
-MANIM_AVAILABLE = find_spec(MANIM_PACKAGE_NAME) is not None
-MANIM_IMPORTED = MANIM_PACKAGE_NAME in sys.modules
-
-MANIMGL_PACKAGE_NAME = "manimlib"
-MANIMGL_AVAILABLE = find_spec(MANIMGL_PACKAGE_NAME) is not None
-MANIMGL_IMPORTED = MANIMGL_PACKAGE_NAME in sys.modules
-
-if MANIM_IMPORTED and MANIMGL_IMPORTED:
-    from manim import logger
-
-    logger.warn(
-        "Both manim and manimgl are installed, therefore `manim-slide` needs to need which one to use. Please only import one of the two modules so that `manim-slide` knows which one to use. Here, manim is used by default"
-    )
-    MANIM = True
-    MANIMGL = False
-elif MANIM_AVAILABLE and not MANIMGL_IMPORTED:
-    MANIM = True
-    MANIMGL = False
-elif MANIMGL_AVAILABLE:
-    MANIM = False
-    MANIMGL = True
-else:
-    raise ImportError(
-        "Either manim (community) or manimgl (3b1b) package must be installed"
-    )
-
-
-FFMPEG_BIN = None
-
-if MANIMGL:
-    from manimlib import Scene, ThreeDScene, config
-    from manimlib.constants import FFMPEG_BIN
-    from manimlib.logger import log as logger
-
-else:
-    from manim import Scene, ThreeDScene, config, logger
-
-    try:  # For manim<v0.16.0.post0
-        from manim.constants import FFMPEG_BIN as FFMPEG_BIN
-    except ImportError:
-        FFMPEG_BIN = config.ffmpeg_executable

manim_slides/present.py

@@ -1,437 +0,0 @@
-import json
-import math
-import os
-import platform
-import sys
-import time
-from enum import IntEnum, auto, unique
-
-if platform.system() == "Windows":
-    import ctypes
-
-import click
-import cv2
-import numpy as np
-
-from .commons import config_path_option
-from .config import Config
-from .defaults import CONFIG_PATH, FOLDER_PATH
-from .slide import reverse_video_path
-
-
-@unique
-class State(IntEnum):
-    PLAYING = auto()
-    PAUSED = auto()
-    WAIT = auto()
-    END = auto()
-
-    def __str__(self):
-        return self.name.capitalize()
-
-
-def now() -> int:
-    return round(time.time() * 1000)
-
-
-def fix_time(x: float) -> float:
-    return x if x > 0 else 1
-
-
-class Presentation:
-    def __init__(self, config, last_frame_next: bool = False):
-        self.last_frame_next = last_frame_next
-        self.slides = config["slides"]
-        self.files = [path for path in config["files"]]
-        self.reverse = False
-        self.reversed_slide = -1
-
-        self.lastframe = []
-
-        self.caps = [None for _ in self.files]
-        self.reset()
-        self.add_last_slide()
-
-    def add_last_slide(self):
-        last_slide_end = self.slides[-1]["end_animation"]
-        last_animation = len(self.files)
-        self.slides.append(
-            dict(
-                start_animation=last_slide_end,
-                end_animation=last_animation,
-                type="last",
-                number=len(self.slides) + 1,
-                terminated=False,
-            )
-        )
-
-    def reset(self):
-        self.current_animation = 0
-        self.load_this_cap(0)
-        self.current_slide_i = 0
-        self.slides[-1]["terminated"] = False
-
-    def next(self):
-        if self.current_slide["type"] == "last":
-            self.current_slide["terminated"] = True
-        else:
-            self.current_slide_i = min(len(self.slides) - 1, self.current_slide_i + 1)
-            self.rewind_slide()
-
-    def prev(self):
-        self.current_slide_i = max(0, self.current_slide_i - 1)
-        self.rewind_slide()
-
-    def reverse_slide(self):
-        self.rewind_slide(reverse=True)
-
-    def rewind_slide(self, reverse: bool = False):
-        self.reverse = reverse
-        self.current_animation = self.current_slide["start_animation"]
-        self.current_cap.set(cv2.CAP_PROP_POS_FRAMES, 0)
-
-    def load_this_cap(self, cap_number: int):
-        if (
-            self.caps[cap_number] is None
-            or (self.reverse and self.reversed_slide != cap_number)
-            or (not self.reverse and self.reversed_slide == cap_number)
-        ):
-            # unload other caps
-            for i in range(len(self.caps)):
-                if not self.caps[i] is None:
-                    self.caps[i].release()
-                    self.caps[i] = None
-            # load this cap
-            file = self.files[cap_number]
-            if self.reverse:
-                self.reversed_slide = cap_number
-                file = "{}_reversed{}".format(*os.path.splitext(file))
-            else:
-                self.reversed_slide = -1
-
-            self.caps[cap_number] = cv2.VideoCapture(file)
-
-    @property
-    def current_slide(self):
-        return self.slides[self.current_slide_i]
-
-    @property
-    def current_cap(self):
-        self.load_this_cap(self.current_animation)
-        return self.caps[self.current_animation]
-
-    @property
-    def fps(self):
-        return self.current_cap.get(cv2.CAP_PROP_FPS)
-
-    # This function updates the state given the previous state.
-    # It does this by reading the video information and checking if the state is still correct.
-    # It returns the frame to show (lastframe) and the new state.
-    def update_state(self, state):
-        if state == State.PAUSED:
-            if len(self.lastframe) == 0:
-                _, self.lastframe = self.current_cap.read()
-            return self.lastframe, state
-        still_playing, frame = self.current_cap.read()
-        if still_playing:
-            self.lastframe = frame
-        elif state in [state.WAIT, state.PAUSED]:
-            return self.lastframe, state
-        elif self.current_slide["type"] == "last" and self.current_slide["terminated"]:
-            return self.lastframe, State.END
-
-        if not still_playing:
-            if self.current_slide["end_animation"] == self.current_animation + 1:
-                if self.current_slide["type"] == "slide":
-                    # To fix "it always ends one frame before the animation", uncomment this.
-                    # But then clears on the next slide will clear the stationary after this slide.
-                    if self.last_frame_next:
-                        self.load_this_cap(self.next_cap)
-                        self.next_cap = self.caps[self.current_animation + 1]
-
-                        self.next_cap.set(cv2.CAP_PROP_POS_FRAMES, 0)
-                        _, self.lastframe = self.next_cap.read()
-                    state = State.WAIT
-                elif self.current_slide["type"] == "loop":
-                    self.current_animation = self.current_slide["start_animation"]
-                    state = State.PLAYING
-                    self.rewind_slide()
-                elif self.current_slide["type"] == "last":
-                    self.current_slide["terminated"] = True
-            elif (
-                self.current_slide["type"] == "last"
-                and self.current_slide["end_animation"] == self.current_animation
-            ):
-                state = State.WAIT
-            else:
-                # Play next video!
-                self.current_animation += 1
-                self.load_this_cap(self.current_animation)
-                # Reset video to position zero if it has been played before
-                self.current_cap.set(cv2.CAP_PROP_POS_FRAMES, 0)
-
-        return self.lastframe, state
-
-
-class Display:
-    def __init__(
-        self,
-        presentations,
-        config,
-        start_paused=False,
-        fullscreen=False,
-        skip_all=False,
-    ):
-        self.presentations = presentations
-        self.start_paused = start_paused
-        self.config = config
-        self.skip_all = skip_all
-
-        self.state = State.PLAYING
-        self.lastframe = None
-        self.current_presentation_i = 0
-
-        self.lag = 0
-        self.last_time = now()
-
-        if platform.system() == "Windows":
-            user32 = ctypes.windll.user32
-            self.screen_width, self.screen_height = user32.GetSystemMetrics(
-                0
-            ), user32.GetSystemMetrics(1)
-
-        if fullscreen:
-            cv2.namedWindow("Video", cv2.WND_PROP_FULLSCREEN)
-            cv2.setWindowProperty(
-                "Video", cv2.WND_PROP_FULLSCREEN, cv2.WINDOW_FULLSCREEN
-            )
-
-    def resize_frame_to_screen(self, frame: np.ndarray):
-        frame_height, frame_width = frame.shape[:2]
-
-        scale_height = self.screen_height / frame_height
-        scale_width = self.screen_width / frame_width
-
-        scale = min(scale_height, scale_width)
-
-        return cv2.resize(frame, (int(scale * frame_height), int(scale * frame_width)))
-
-    @property
-    def current_presentation(self):
-        return self.presentations[self.current_presentation_i]
-
-    def run(self):
-        while True:
-            self.lastframe, self.state = self.current_presentation.update_state(
-                self.state
-            )
-            if self.state == State.PLAYING or self.state == State.PAUSED:
-                if self.start_paused:
-                    self.state = State.PAUSED
-                    self.start_paused = False
-            if self.state == State.END:
-                if self.current_presentation_i == len(self.presentations) - 1:
-                    self.quit()
-                else:
-                    self.current_presentation_i += 1
-                    self.state = State.PLAYING
-            self.handle_key()
-            self.show_video()
-            self.show_info()
-
-    def show_video(self):
-        self.lag = now() - self.last_time
-        self.last_time = now()
-
-        frame = self.lastframe
-
-        if platform.system() == "Windows":
-            frame = self.resize_frame_to_screen(frame)
-
-        cv2.imshow("Video", frame)
-
-    def show_info(self):
-        info = np.zeros((130, 420), np.uint8)
-        font_args = (cv2.FONT_HERSHEY_SIMPLEX, 0.7, 255)
-        grid_x = [30, 230]
-        grid_y = [30, 70, 110]
-
-        cv2.putText(
-            info,
-            f"Animation: {self.current_presentation.current_animation}",
-            (grid_x[0], grid_y[0]),
-            *font_args,
-        )
-        cv2.putText(info, f"State: {self.state}", (grid_x[1], grid_y[0]), *font_args)
-
-        cv2.putText(
-            info,
-            f"Slide {self.current_presentation.current_slide['number']}/{len(self.current_presentation.slides)}",
-            (grid_x[0], grid_y[1]),
-            *font_args,
-        )
-        cv2.putText(
-            info,
-            f"Slide Type: {self.current_presentation.current_slide['type']}",
-            (grid_x[1], grid_y[1]),
-            *font_args,
-        )
-
-        cv2.putText(
-            info,
-            f"Scene  {self.current_presentation_i + 1}/{len(self.presentations)}",
-            ((grid_x[0] + grid_x[1]) // 2, grid_y[2]),
-            *font_args,
-        )
-
-        cv2.imshow("Info", info)
-
-    def handle_key(self):
-        sleep_time = math.ceil(1000 / self.current_presentation.fps)
-        key = cv2.waitKeyEx(fix_time(sleep_time - self.lag))
-
-        if self.config.QUIT.match(key):
-            self.quit()
-        elif self.state == State.PLAYING and self.config.PLAY_PAUSE.match(key):
-            self.state = State.PAUSED
-        elif self.state == State.PAUSED and self.config.PLAY_PAUSE.match(key):
-            self.state = State.PLAYING
-        elif self.state == State.WAIT and (
-            self.config.CONTINUE.match(key) or self.config.PLAY_PAUSE.match(key)
-        ):
-            self.current_presentation.next()
-            self.state = State.PLAYING
-        elif (
-            self.state == State.PLAYING and self.config.CONTINUE.match(key)
-        ) or self.skip_all:
-            self.current_presentation.next()
-        elif self.config.BACK.match(key):
-            if self.current_presentation.current_slide_i == 0:
-                self.current_presentation_i = max(0, self.current_presentation_i - 1)
-                self.current_presentation.reset()
-                self.state = State.PLAYING
-            else:
-                self.current_presentation.prev()
-                self.state = State.PLAYING
-        elif self.config.REVERSE.match(key):
-            self.current_presentation.reverse_slide()
-            self.state = State.PLAYING
-        elif self.config.REWIND.match(key):
-            self.current_presentation.rewind_slide()
-            self.state = State.PLAYING
-
-    def quit(self):
-        cv2.destroyAllWindows()
-        sys.exit()
-
-
-@click.command()
-@click.option(
-    "--folder",
-    default=FOLDER_PATH,
-    type=click.Path(exists=True, file_okay=False),
-    help="Set slides folder.",
-)
-@click.help_option("-h", "--help")
-def list_scenes(folder):
-    """List available scenes."""
-
-    for i, scene in enumerate(_list_scenes(folder), start=1):
-        click.secho(f"{i}: {scene}", fg="green")
-
-
-def _list_scenes(folder):
-    scenes = []
-
-    for file in os.listdir(folder):
-        if file.endswith(".json"):
-            scenes.append(os.path.basename(file)[:-5])
-
-    return scenes
-
-
-@click.command()
-@click.argument("scenes", nargs=-1)
-@config_path_option
-@click.option(
-    "--folder",
-    default=FOLDER_PATH,
-    type=click.Path(exists=True, file_okay=False),
-    help="Set slides folder.",
-)
-@click.option("--start-paused", is_flag=True, help="Start paused.")
-@click.option("--fullscreen", is_flag=True, help="Fullscreen mode.")
-@click.option(
-    "--last-frame-next",
-    is_flag=True,
-    help="Show the next animation first frame as last frame (hack).",
-)
-@click.option(
-    "--skip-all",
-    is_flag=True,
-    help="Skip all slides, useful the test if slides are working.",
-)
-@click.help_option("-h", "--help")
-def present(
-    scenes, config_path, folder, start_paused, fullscreen, last_frame_next, skip_all
-):
-    """Present the different scenes."""
-
-    if len(scenes) == 0:
-        scene_choices = _list_scenes(folder)
-
-        scene_choices = dict(enumerate(scene_choices, start=1))
-
-        for i, scene in scene_choices.items():
-            click.secho(f"{i}: {scene}", fg="green")
-
-        click.echo()
-
-        click.echo("Choose number corresponding to desired scene/arguments.")
-        click.echo("(Use comma separated list for multiple entries)")
-
-        def value_proc(value: str):
-            indices = list(map(int, value.strip().replace(" ", "").split(",")))
-
-            if not all(map(lambda i: 0 < i <= len(scene_choices), indices)):
-                raise click.UsageError(
-                    "Please only enter numbers displayed on the screen."
-                )
-
-            return [scene_choices[i] for i in indices]
-
-        if len(scene_choices) == 0:
-            raise click.UsageError(
-                "No scenes were found, are you in the correct directory?"
-            )
-
-        while True:
-            try:
-                scenes = click.prompt("Choice(s)", value_proc=value_proc)
-                break
-            except ValueError as e:
-                raise click.UsageError(e)
-
-    presentations = list()
-    for scene in scenes:
-        config_file = os.path.join(folder, f"{scene}.json")
-        if not os.path.exists(config_file):
-            raise click.UsageError(
-                f"File {config_file} does not exist, check the scene name and make sure to use Slide as your scene base class"
-            )
-        config = json.load(open(config_file))
-        presentations.append(Presentation(config, last_frame_next=last_frame_next))
-
-    if os.path.exists(config_path):
-        config = Config.parse_file(config_path)
-    else:
-        config = Config()
-
-    display = Display(
-        presentations,
-        config=config,
-        start_paused=start_paused,
-        fullscreen=fullscreen,
-        skip_all=skip_all,
-    )
-    display.run()

manim_slides/slide.py

@@ -1,194 +0,0 @@
-import json
-import os
-import platform
-import shutil
-import subprocess
-
-from tqdm import tqdm
-
-from .defaults import FOLDER_PATH
-from .manim import FFMPEG_BIN, MANIMGL, Scene, ThreeDScene, config, logger
-
-
-def reverse_video_path(src: str) -> str:
-    file, ext = os.path.splitext(src)
-    return f"{file}_reversed{ext}"
-
-
-def reverse_video_file(src: str, dst: str):
-    command = [FFMPEG_BIN, "-i", src, "-vf", "reverse", dst]
-    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-    process.communicate()
-
-
-class Slide(Scene):
-    def __init__(self, *args, output_folder=FOLDER_PATH, **kwargs):
-        if MANIMGL:
-            if not os.path.isdir("videos"):
-                os.mkdir("videos")
-            kwargs["file_writer_config"] = {
-                "break_into_partial_movies": True,
-                "output_directory": "",
-                "write_to_movie": True,
-            }
-
-            kwargs["preview"] = False
-
-        super().__init__(*args, **kwargs)
-
-        self.output_folder = output_folder
-        self.slides = list()
-        self.current_slide = 1
-        self.current_animation = 0
-        self.loop_start_animation = None
-        self.pause_start_animation = 0
-
-    @property
-    def partial_movie_files(self):
-        if MANIMGL:
-            from manimlib.utils.file_ops import get_sorted_integer_files
-
-            kwargs = {
-                "remove_non_integer_files": True,
-                "extension": self.file_writer.movie_file_extension,
-            }
-            return get_sorted_integer_files(
-                self.file_writer.partial_movie_directory, **kwargs
-            )
-        else:
-            return self.renderer.file_writer.partial_movie_files
-
-    @property
-    def show_progress_bar(self):
-        if MANIMGL:
-            return getattr(super(Scene, self), "show_progress_bar", True)
-        else:
-            return config["progress_bar"] != "none"
-
-    @property
-    def leave_progress_bar(self):
-        if MANIMGL:
-            return getattr(super(Scene, self), "leave_progress_bars", False)
-        else:
-            return config["progress_bar"] == "leave"
-
-    def play(self, *args, **kwargs):
-        super().play(*args, **kwargs)
-        self.current_animation += 1
-
-    def pause(self):
-        self.slides.append(
-            dict(
-                type="slide",
-                start_animation=self.pause_start_animation,
-                end_animation=self.current_animation,
-                number=self.current_slide,
-            )
-        )
-        self.current_slide += 1
-        self.pause_start_animation = self.current_animation
-
-    def start_loop(self):
-        assert self.loop_start_animation is None, "You cannot nest loops"
-        self.loop_start_animation = self.current_animation
-
-    def end_loop(self):
-        assert (
-            self.loop_start_animation is not None
-        ), "You have to start a loop before ending it"
-        self.slides.append(
-            dict(
-                type="loop",
-                start_animation=self.loop_start_animation,
-                end_animation=self.current_animation,
-                number=self.current_slide,
-            )
-        )
-        self.current_slide += 1
-        self.loop_start_animation = None
-        self.pause_start_animation = self.current_animation
-
-    def save_slides(self, use_cache=True):
-
-        if not os.path.exists(self.output_folder):
-            os.mkdir(self.output_folder)
-
-        files_folder = os.path.join(self.output_folder, "files")
-        if not os.path.exists(files_folder):
-            os.mkdir(files_folder)
-
-        scene_name = type(self).__name__
-        scene_files_folder = os.path.join(files_folder, scene_name)
-
-        old_animation_files = set()
-
-        if not os.path.exists(scene_files_folder):
-            os.mkdir(scene_files_folder)
-        elif not use_cache:
-            shutil.rmtree(scene_files_folder)
-            os.mkdir(scene_files_folder)
-        else:
-            old_animation_files.update(os.listdir(scene_files_folder))
-
-        files = list()
-        for src_file in tqdm(
-            self.partial_movie_files,
-            desc=f"Copying animation files to '{scene_files_folder}' and generating reversed animations",
-            leave=self.leave_progress_bar,
-            ascii=True if platform.system() == "Windows" else None,
-            disable=not self.show_progress_bar,
-        ):
-            filename = os.path.basename(src_file)
-            _hash, ext = os.path.splitext(filename)
-
-            rev_filename = f"{_hash}_reversed{ext}"
-
-            dst_file = os.path.join(scene_files_folder, filename)
-            # We only copy animation if it was not present
-            if filename in old_animation_files:
-                old_animation_files.remove(filename)
-            else:
-                shutil.copyfile(src_file, dst_file)
-
-            # We only reverse video if it was not present
-            if rev_filename in old_animation_files:
-                old_animation_files.remove(rev_filename)
-            else:
-                rev_file = os.path.join(scene_files_folder, rev_filename)
-                reverse_video_file(src_file, rev_file)
-
-            files.append(dst_file)
-
-        logger.info(
-            f"Copied {len(files)} animations to '{os.path.abspath(scene_files_folder)}' and generated reversed animations"
-        )
-
-        slide_path = os.path.join(self.output_folder, "%s.json" % (scene_name,))
-
-        f = open(slide_path, "w")
-        json.dump(dict(slides=self.slides, files=files), f)
-        f.close()
-        logger.info(
-            f"Slide '{scene_name}' configuration written in '{os.path.abspath(slide_path)}'"
-        )
-
-    def run(self, *args, **kwargs):
-        """MANIMGL renderer"""
-        super().run(*args, **kwargs)
-        self.save_slides(use_cache=False)
-
-    def render(self, *args, **kwargs):
-        """MANIM render"""
-        # We need to disable the caching limit since we rely on intermidiate files
-        max_files_cached = config["max_files_cached"]
-        config["max_files_cached"] = float("inf")
-
-        super().render(*args, **kwargs)
-
-        config["max_files_cached"] = max_files_cached
-
-        self.save_slides()
-
-
-class ThreeDSlide(Slide, ThreeDScene):
-    pass

manim_slides/wizard.py

@@ -1,75 +0,0 @@
-import os
-import sys
-
-import click
-import cv2
-import numpy as np
-
-from .commons import config_options
-from .config import Config
-from .defaults import CONFIG_PATH
-
-
-def prompt(question: str) -> int:
-    font_args = (cv2.FONT_HERSHEY_SIMPLEX, 0.7, 255)
-    display = np.zeros((130, 420), np.uint8)
-
-    cv2.putText(display, "* Manim Slides Wizard *", (70, 33), *font_args)
-    cv2.putText(display, question, (30, 85), *font_args)
-
-    cv2.imshow("Manim Slides Configuration Wizard", display)
-    return cv2.waitKeyEx(-1)
-
-
-@click.command()
-@config_options
-def wizard(config_path, force, merge):
-    """Launch configuration wizard."""
-    return _init(config_path, force, merge, skip_interactive=False)
-
-
-@click.command()
-@config_options
-def init(config_path, force, merge, skip_interactive=False):
-    """Initialize a new default configuration file."""
-    return _init(config_path, force, merge, skip_interactive=True)
-
-
-def _init(config_path, force, merge, skip_interactive=False):
-
-    if os.path.exists(config_path):
-        click.secho(f"The `{CONFIG_PATH}` configuration file exists")
-
-        if not force and not merge:
-            choice = click.prompt(
-                "Do you want to continue and (o)verwrite / (m)erge it, or (q)uit?",
-                type=click.Choice(["o", "m", "q"], case_sensitive=False),
-            )
-
-            force = choice == "o"
-            merge = choice == "m"
-
-        if force:
-            click.secho("Overwriting.")
-        elif merge:
-            click.secho("Merging.")
-        else:
-            click.secho("Exiting.")
-            sys.exit(0)
-
-    config = Config()
-
-    if not skip_interactive:
-
-        prompt("Press any key to continue")
-
-        for _, key in config:
-            key.ids = [prompt(f"Press the {key.name} key")]
-
-    if merge:
-        config = Config.parse_file(config_path).merge_with(config)
-
-    with open(config_path, "w") as config_file:
-        config_file.write(config.json(indent=4))
-
-    click.echo(f"Configuration file successfully save to `{config_path}`")

setup.py

@@ -1,46 +0,0 @@
-import sys
-
-import setuptools
-
-from manim_slides import __version__ as version
-
-if sys.version_info < (3, 7):
-    raise RuntimeError("This package requires Python 3.7+")
-
-with open("README.md", "r") as f:
-    long_description = f.read()
-
-setuptools.setup(
-    name="manim-slides",
-    version=version,
-    author="Jérome Eertmans (previously, Federico A. Galatolo)",
-    author_email="jeertmans@icloud.com (resp., federico.galatolo@ing.unipi.it)",
-    description="Tool for live presentations using manim",
-    url="https://github.com/jeertmans/manim-slides",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    packages=setuptools.find_packages(),
-    entry_points={
-        "console_scripts": [
-            "manim-slides=manim_slides.main:cli",
-        ],
-    },
-    python_requires=">=3.7",
-    install_requires=[
-        "click>=8.0",
-        "click-default-group>=1.2",
-        "numpy>=1.19.3",
-        "pydantic>=1.9.1",
-        "opencv-python>=4.6",
-        "tqdm>=4.62.3",
-    ],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-        "Operating System :: OS Independent",
-    ],
-)