chore(version): bump 4.9.2 to 4.10.0

* feat(convert): PowerPoint conversion 

You can now convert your presentations to PowerPoint

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* chore(convert): autoplay media

* chore(deps): remove pkg_resources in favor to importlib

This is what pkg_resources' team recommends

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(deps): if case for Python 3.8 (<3.9)

* fix(convert): use correct pkg path

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(deps): remove duplicate deps

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix(lib): add __init__.py

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 4.10.0
+commit = True
+message = chore(version): bump {current_version} to {new_version}
+
+[bumpversion:file:manim_slides/__version__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"

.flake8

@@ -1,5 +0,0 @@
-[flake8]
-min_python_version = 3.7
-extend-ignore =
-    # E501: line too long
-    E501,

.github/ISSUE_TEMPLATE/bug.yml

@@ -1,40 +1,40 @@
 name: Bug
 description: Report an issue to help improve the project.
-labels: "bug"
+labels: bug
 title: '[BUG] <description>'
 body:
-  - type: textarea
+- type: textarea
-    id: description
+  id: description
-    attributes:
+  attributes:
-      label: Description
+    label: Description
-      description: A brief description of the question or issue, also include what you tried and what didn't work
+    description: A brief description of the question or issue, also include what you tried and what didn't work
-    validations:
+  validations:
-      required: true
+    required: true
-  - type: textarea
+- type: textarea
-    id: version
+  id: version
-    attributes:
+  attributes:
-      label: Version
+    label: Version
-      description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information.
+    description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information.
-    validations:
+  validations:
-      required: true
+    required: true
-  - type: textarea
+- type: textarea
-    id: platform
+  id: platform
-    attributes:
+  attributes:
-      label: Platform
+    label: Platform
-      description: What is your platform. Linux, macOS, or Windows?
+    description: What is your platform. Linux, macOS, or Windows?
-    validations:
+  validations:
-      required: true
+    required: true
-  - type: textarea
+- type: textarea
-    id: screenshots
+  id: screenshots
-    attributes:
+  attributes:
-      label: Screenshots
+    label: Screenshots
-      description: Please add screenshots if applicable
+    description: Please add screenshots if applicable
-    validations:
+  validations:
-      required: false
+    required: false
-  - type: textarea
+- type: textarea
-    id: extrainfo
+  id: extrainfo
-    attributes:
+  attributes:
-      label: Additional information
+    label: Additional information
-      description: Is there anything else we should know about this bug?
+    description: Is there anything else we should know about this bug?
-    validations:
+  validations:
-      required: false
+    required: false

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,59 +1,59 @@
 name: Documentation
 description: Ask / Report an issue related to the documentation.
-title: "DOC: <description>"
+title: 'DOC: <description>'
-labels: ['bug', 'docs']
+labels: [bug, docs]
 
 body:
-  - type: markdown
+- type: markdown
-    attributes:
+  attributes:
-      value: >
+    value: >
-        **Thank you for wanting to report a problem with manim-slides docs!**
+      **Thank you for wanting to report a problem with manim-slides docs!**
 
 
-        If the problem seems straightforward, feel free to submit a PR instead!
+      If the problem seems straightforward, feel free to submit a PR instead!
 
 
-        ⚠
+      ⚠
-        Verify first that your issue is not already reported on GitHub [Issues].
+      Verify first that your issue is not already reported on GitHub [Issues].
 
 
-        [Issues]:
+      [Issues]:
-        https://github.com/jeertmans/manim-slides/issues
+      https://github.com/jeertmans/manim-slides/issues
 
-  - type: textarea
+- type: textarea
-    attributes:
+  attributes:
-      label: Describe the Issue
+    label: Describe the Issue
-      description: A clear and concise description of the issue you encountered.
+    description: A clear and concise description of the issue you encountered.
-    validations:
+  validations:
-      required: true
+    required: true
 
-  - type: input
+- type: input
-    attributes:
+  attributes:
-      label: Affected Page
+    label: Affected Page
-      description: Add a link to page with the problem.
+    description: Add a link to page with the problem.
-    validations:
+  validations:
-      required: true
+    required: true
 
-  - type: dropdown
+- type: dropdown
-    attributes:
+  attributes:
-      label: Issue Type
+    label: Issue Type
-      description: >
+    description: >
-        Please select the option in the drop-down.
+      Please select the option in the drop-down.
 
-        <details>
+      <details>
-          <summary>
+        <summary>
-            <em>Issue?</em>
+          <em>Issue?</em>
-          </summary>
+        </summary>
-        </details>
+      </details>
-      options:
+    options:
-        - Documentation Enhancement
+    - Documentation Enhancement
-        - Documentation Report
+    - Documentation Report
-    validations:
+  validations:
-      required: true
+    required: true
 
-  - type: textarea
+- type: textarea
-    attributes:
+  attributes:
-      label: Recommended fix or suggestions
+    label: Recommended fix or suggestions
-      description: A clear and concise description of how you want to update it.
+    description: A clear and concise description of how you want to update it.
-    validations:
+  validations:
-      required: false
+    required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,26 +1,26 @@
 name: Feature Request
 description: Have a new idea/feature? Please suggest!
-labels: "enhancement"
+labels: enhancement
 title: '[FEATURE] <description>'
 body:
-  - type: textarea
+- type: textarea
-    id: description
+  id: description
-    attributes:
+  attributes:
-      label: Description
+    label: Description
-      description: A brief description of the enhancement you propose, also include what you tried and what worked.
+    description: A brief description of the enhancement you propose, also include what you tried and what worked.
-    validations:
+  validations:
-      required: true
+    required: true
-  - type: textarea
+- type: textarea
-    id: screenshots
+  id: screenshots
-    attributes:
+  attributes:
-      label: Screenshots
+    label: Screenshots
-      description: Please add screenshots if applicable
+    description: Please add screenshots if applicable
-    validations:
+  validations:
-      required: false
+    required: false
-  - type: textarea
+- type: textarea
-    id: extrainfo
+  id: extrainfo
-    attributes:
+  attributes:
-      label: Additional information
+    label: Additional information
-      description: Is there anything else we should know about this idea?
+    description: Is there anything else we should know about this idea?
-    validations:
+  validations:
-      required: false
+    required: false

.github/ISSUE_TEMPLATE/support.yml

@@ -1,14 +1,14 @@
 name: Question/Help/Support
 description: Ask us about Manim Slides
-title: "Support: Ask us anything"
+title: 'Support: Ask us anything'
-labels: ['help', 'question']
+labels: [help, question]
 
 body:
-  - type: textarea
+- type: textarea
-    attributes:
+  attributes:
-      label: "Please explain the issue you're experiencing (with as much detail as possible):"
+    label: "Please explain the issue you're experiencing (with as much detail as possible):"
-      description: >
+    description: >
-        Please make sure to leave a reference to the document/code you're
+      Please make sure to leave a reference to the document/code you're
-        referring to.
+      referring to.
-    validations:
+  validations:
-      required: true
+    required: true

.github/workflows/clearcache.yml

@@ -0,0 +1,34 @@
+# From: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#force-deleting-cache-entries
+name: Cleanup caches by a branch
+on:
+  pull_request:
+    types:
+    - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+
+    - name: Cleanup
+      run: |
+        gh extension install actions/gh-actions-cache
+
+        REPO=${{ github.repository }}
+        BRANCH="refs/pull/${{ github.event.pull_request.number }}/merge"
+
+        echo "Fetching list of cache key"
+        cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
+
+        ## Setting this to not fail the workflow while deleting cache keys.
+        set +e
+        echo "Deleting caches..."
+        for cacheKey in $cacheKeysForPR
+        do
+            gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
+        done
+        echo "Done"
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -9,16 +9,16 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: CodeQL
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    branches: [main]
   schedule:
-    - cron: '45 3 * * 2'
+  - cron: 45 3 * * 2
 
 jobs:
   analyze:
@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'python' ]
+        language: [python]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 

.github/workflows/draft-pdf.yml

@@ -0,0 +1,33 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Create JOSE Paper
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    paths:
+    - paper/*
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Build draft PDF
+      uses: openjournals/openjournals-draft-action@master
+      with:
+        journal: jose
+          # This should be the path to the paper within your repo.
+        paper-path: paper/paper.md
+    - name: Upload
+      uses: actions/upload-artifact@v1
+      with:
+        name: paper
+        # This is the output path where Pandoc will write the compiled
+        # PDF. Note, this should be the same directory as the input
+        # paper.md
+        path: paper/paper.pdf

.github/workflows/languagetool.yml

@@ -8,8 +8,8 @@ jobs:
   languagetool_check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+    - uses: actions/checkout@v1
-      - uses: reviewdog/action-languagetool@v1
+    - uses: reviewdog/action-languagetool@v1
-        with:
+      with:
-          reporter: github-pr-review
+        reporter: github-pr-review
-          level: warning
+        level: warning

.github/workflows/pages.yml

@@ -4,7 +4,9 @@ name: Deploy static content to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches: [main]
+
+  pull_request:
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -17,45 +19,70 @@ permissions:
 
 # Allow one concurrent deployment
 concurrency:
-  group: "pages"
+  group: pages
   cancel-in-progress: true
 
 jobs:
   # Single deploy job since we're just deploying
   deploy:
+    permissions: write-all
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+    - name: Checkout
-        uses: actions/checkout@v3
+      uses: actions/checkout@v3
-      - name: Install Poetry
+    - name: Install Poetry
-        run: pipx install poetry
+      run: pipx install poetry
-      - name: Install Python
+    - name: Install Python
-        uses: actions/setup-python@v4
+      uses: actions/setup-python@v4
-        with:
+      with:
-          python-version: '3.9'
+        python-version: '3.9'
-          cache: 'poetry'
+        cache: poetry
-      - name: Setup Pages
+    - name: Setup Pages
-        uses: actions/configure-pages@v2
+      uses: actions/configure-pages@v2
-      - name: Install Linux Dependencies
+    - name: Install Linux Dependencies
-        run: sudo apt install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
+      run: |
-      - name: Install Python dependencies
+        sudo apt-get update
-        run: pip install manim sphinx sphinx_click furo
+        sudo apt-get install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
-      - name: Install local Python package
+    - name: Install Python dependencies
-        run: poetry install --with docs
+      run: pip install manim sphinx sphinx_click furo
-      - name: Build animation and convert it into HTML slides
+    - name: Install local Python package
-        run: |
+      run: poetry install --with docs
-          poetry run manim example.py ConvertExample
+    - name: Restore cached media
-          poetry run manim-slides convert ConvertExample docs/source/_static/slides.html -ccontrols=true
+      id: cache-media-restore
-      - name: Build docs
+      uses: actions/cache/restore@v3
-        run: cd docs && make html
+      with:
-      - name: Upload artifact
+        path: media
-        uses: actions/upload-pages-artifact@v1
+        key: ${{ runner.os }}-media
-        with:
+    - name: Build animation and convert it into HTML slides
-          # Upload docs/build/html dir
+      run: |
-          path: 'docs/build/html/'
+        poetry run manim example.py ConvertExample BasicExample ThreeDExample
-      - name: Deploy to GitHub Pages
+        poetry run manim-slides convert ConvertExample docs/source/_static/slides.html -ccontrols=true
-        id: deployment
+        poetry run manim-slides convert BasicExample docs/source/_static/basic_example.html -ccontrols=true
-        uses: actions/deploy-pages@v1
+        poetry run manim-slides convert ThreeDExample docs/source/_static/three_d_example.html -ccontrols=true
+    - name: Clear cache
+      run: |
+        gh extension install actions/gh-actions-cache
+        gh actions-cache delete ${{ steps.cache-media-restore.outputs.cache-primary-key }} --confirm || true
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Save media to cache
+      id: cache-media-save
+      uses: actions/cache/save@v3
+      with:
+        path: media
+        key: ${{ steps.cache-media-restore.outputs.cache-primary-key }}
+    - name: Build docs
+      run: cd docs && poetry run make html
+    - name: Upload artifact
+      if: github.event_name != 'pull_request'
+      uses: actions/upload-pages-artifact@v1
+      with:
+        # Upload docs/build/html dir
+        path: docs/build/html/
+    - name: Deploy to GitHub Pages
+      id: deployment
+      if: github.event_name != 'pull_request'
+      uses: actions/deploy-pages@v1

.github/workflows/python-publish.yml

@@ -16,33 +16,33 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+    - uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v2
 
-      - name: Install build package
+    - name: Install build package
-        run: python -m pip install -U build
+      run: python -m pip install -U build
 
-      - name: Build wheels
+    - name: Build wheels
-        run: python -m build --sdist
+      run: python -m build --sdist
 
-      - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v2
-        with:
+      with:
-          name: dist
+        name: dist
-          path: dist/*.tar.*
+        path: dist/*.tar.*
 
   release:
     name: Release
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
-    needs: [ build_wheels ]
+    needs: [build_wheels]
     steps:
-      - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v2
-        with:
+      with:
-          name: dist
+        name: dist
-          path: dist/
+        path: dist/
-      - name: Upload to PyPI
+    - name: Upload to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+      uses: pypa/gh-action-pypi-publish@master
-        with:
+      with:
-          user: __token__
+        user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test_examples.yml

@@ -1,8 +1,8 @@
 on:
   pull_request:
     paths:
-      - '**.py'
+    - '**.py'
-      - '.github/workflows/test_examples.yml'
+    - .github/workflows/test_examples.yml
   workflow_dispatch:
 
 name: Test Examples
@@ -11,7 +11,7 @@ env:
   QT_QPA_PLATFORM: offscreen
   MANIM_SLIDES_VERBOSITY: debug
   PYTHONFAULTHANDLER: 1
-  DISPLAY: ":99"
+  DISPLAY: :99
 
 jobs:
   build-examples:
@@ -44,74 +44,77 @@ jobs:
           manim: manim
     runs-on: ${{ matrix.os }}
     steps:
-      - name: Checkout repository
+    - name: Checkout repository
-        uses: actions/checkout@v3
+      uses: actions/checkout@v3
-      - name: Install Poetry
+    - name: Install Poetry
-        run: pipx install poetry
+      run: pipx install poetry
-      - name: Install Python
+    - name: Install Python
-        uses: actions/setup-python@v4
+      uses: actions/setup-python@v4
-        with:
+      with:
-          python-version: ${{ matrix.pyversion }}
+        python-version: ${{ matrix.pyversion }}
-          cache: 'poetry'
+        cache: poetry
 
       # Path related stuff
-      - name: Append to Path on MacOS
+    - name: Append to Path on MacOS
-        if: matrix.os == 'macos-latest'
+      if: matrix.os == 'macos-latest'
-        run: |
+      run: |
-          echo "${HOME}/.local/bin" >> $GITHUB_PATH
+        echo "${HOME}/.local/bin" >> $GITHUB_PATH
-          echo "/Users/runner/Library/Python/${{ matrix.pyversion }}/bin" >> $GITHUB_PATH
+        echo "/Users/runner/Library/Python/${{ matrix.pyversion }}/bin" >> $GITHUB_PATH
-      - name: Append to Path on Ubuntu
+    - name: Append to Path on Ubuntu
-        if: matrix.os == 'ubuntu-latest'
+      if: matrix.os == 'ubuntu-latest'
-        run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
+      run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
-      - name: Append to Path on Windows
+    - name: Append to Path on Windows
-        if: matrix.os == 'windows-latest'
+      if: matrix.os == 'windows-latest'
-        run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+      run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
       # OS depedencies
-      - name: Install manim dependencies on MacOs
+    - name: Install manim dependencies on MacOs
-        if: matrix.os == 'macos-latest' && matrix.manim == 'manim'
+      if: matrix.os == 'macos-latest' && matrix.manim == 'manim'
-        run: brew install ffmpeg py3cairo
+      run: brew install ffmpeg py3cairo
-      - name: Install manimgl dependencies on MacOS
+    - name: Install manimgl dependencies on MacOS
-        if: matrix.os == 'macos-latest' && matrix.manim == 'manimgl'
+      if: matrix.os == 'macos-latest' && matrix.manim == 'manimgl'
-        run: brew install ffmpeg
+      run: brew install ffmpeg
-      - name: Install manim dependencies on Ubuntu
+    - name: Run apt-get update on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
+      if: matrix.os == 'ubuntu-latest'
-        run: |
+      run: sudo apt-get update
-          sudo apt-get install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
+    - name: Install manim dependencies on Ubuntu
-      - name: Install manimgl dependencies on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
+      run: |
-        run: |
+        sudo apt-get install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
-          sudo apt-get install libpango1.0-dev ffmpeg freeglut3-dev
+    - name: Install manimgl dependencies on Ubuntu
-      - name: Install xvfb on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
+      run: |
-        run: |
+        sudo apt-get install libpango1.0-dev ffmpeg freeglut3-dev
-          sudo apt-get install xvfb
+    - name: Install xvfb on Ubuntu
-          nohup Xvfb $DISPLAY &
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
-      - name: Install Windows dependencies
+      run: |
-        if: matrix.os == 'windows-latest'
+        sudo apt-get install xvfb
-        run: choco install ffmpeg
+        nohup Xvfb $DISPLAY &
+    - name: Install Windows dependencies
+      if: matrix.os == 'windows-latest'
+      run: choco install ffmpeg
 
       # Install Manim Slides
-      - name: Install Manim Slides
+    - name: Install Manim Slides
-        run: |
+      run: |
-          poetry config experimental.new-installer false
+        poetry config experimental.new-installer false
-          poetry install --with test
+        poetry install --with test
 
-      # Render slides
+    # Render slides
-      - name: Render slides
+    - name: Render slides
-        if: matrix.manim == 'manim'
+      if: matrix.manim == 'manim'
-        run: poetry run manim -ql example.py Example ThreeDExample
+      run: poetry run manim -ql example.py BasicExample ThreeDExample
-      - name: Render slides
+    - name: Render slides
-        if: matrix.manim == 'manimgl'
+      if: matrix.manim == 'manimgl'
-        run: poetry run -v manimgl -l example.py Example ThreeDExample
+      run: poetry run -v manimgl -l example.py BasicExample ThreeDExample
 
-      # Play slides
+    # Play slides
-      - name: Test slides
+    - name: Test slides
-        run: poetry run manim-slides Example ThreeDExample --skip-all
+      run: poetry run manim-slides BasicExample ThreeDExample --skip-all
 
-      # Test slides to html
+    # Test slides to html
-      - name: Test convert on Ubuntu
+    - name: Test convert on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
-        run: |
+      run: |
-          poetry run manim -ql example.py ConvertExample
+        poetry run manim -ql example.py ConvertExample
-          poetry run manim-slides convert --to=html ConvertExample index.html
+        poetry run manim-slides convert --to=html ConvertExample index.html

.gitignore

@@ -27,3 +27,17 @@ docs/source/_static/slides.html
 slides_assets/
 
 slides.html
+
+docs/source/_static/basic_example_assets/
+
+docs/source/_static/basic_example.html
+
+docs/source/_static/three_d_example.html
+
+docs/source/_static/three_d_example_assets/
+
+paper/media/
+
+*.jats
+
+paper/paper.pdf

.pre-commit-config.yaml

@@ -1,30 +1,34 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+- repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+  rev: v4.4.0
-    hooks:
+  hooks:
-    -   id: check-yaml
+  - id: check-yaml
-    -   id: end-of-file-fixer
+  - id: check-toml
-    -   id: trailing-whitespace
+  - id: end-of-file-fixer
--   repo: https://github.com/pycqa/isort
+  - id: trailing-whitespace
-    rev: 5.11.4
+- repo: https://github.com/pycqa/isort
-    hooks:
+  rev: 5.12.0
-      - id: isort
+  hooks:
-        name: isort (python)
+  - id: isort
--   repo: https://github.com/psf/black
+    name: isort (python)
-    rev: 22.12.0
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    hooks:
+  rev: v2.7.0
-      - id: black
+  hooks:
--   repo: https://github.com/PyCQA/flake8
+  - id: pretty-format-yaml
-    rev: 6.0.0
+    args: [--autofix]
-    hooks:
+  - id: pretty-format-toml
-      - id: flake8
+    exclude: poetry.lock
-        additional_dependencies:
+    args: [--autofix]
-        - flake8-bugbear
+- repo: https://github.com/psf/black
-        - flake8-comprehensions
+  rev: 23.1.0
-        - flake8-tidy-imports
+  hooks:
-        - flake8-typing-imports
+  - id: black
--   repo: https://github.com/pre-commit/mirrors-mypy
+- repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.991'
+  rev: v0.0.254
-    hooks:
+  hooks:
-    -   id: mypy
+  - id: ruff
-        additional_dependencies: [types-requests, types-setuptools]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.0.1
+  hooks:
+  - id: mypy
+    additional_dependencies: [types-requests, types-setuptools]

LICENSE.md

@@ -1,674 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
+MIT License
-                       Version 3, 29 June 2007
+
-
+Copyright (c) 2023 Jérome Eertmans
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
- Everyone is permitted to copy and distribute verbatim copies
+Permission is hereby granted, free of charge, to any person obtaining a copy
- of this license document, but changing it is not allowed.
+of this software and associated documentation files (the "Software"), to deal
-
+in the Software without restriction, including without limitation the rights
-                            Preamble
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-
+copies of the Software, and to permit persons to whom the Software is
-  The GNU General Public License is a free, copyleft license for
+furnished to do so, subject to the following conditions:
-software and other kinds of works.
+
-
+The above copyright notice and this permission notice shall be included in all
-  The licenses for most software and other practical works are designed
+copies or substantial portions of the Software.
-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
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-share and change all versions of a program--to make sure it remains free
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-software for all its users.  We, the Free Software Foundation, use the
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-GNU General Public License for most of our software; it applies also to
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-any other work released this way by its authors.  You can apply it to
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-your programs, too.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
+SOFTWARE.
-  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,13 +1,18 @@
-![Manim Slides Logo](https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo_dark_transparent.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo_light_transparent.png">
+  <img alt="Manim Slides Logo" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/logo.png">
+</picture>
 
 [![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)
+[![PyPI - Downloads][pypi-download-badge]][pypi-version-url]
+[![Documentation][documentation-badge]][documentation-url]
 # Manim Slides
 
 Tool for live presentations using either [Manim (community edition)](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!
+> **NOTE:** this project extends the work of [`manim-presentation`](https://github.com/galatolofederico/manim-presentation), with a lot more features!
 
 - [Installation](#installation)
   * [Dependencies](#dependencies)
@@ -25,16 +30,22 @@ Tool for live presentations using either [Manim (community edition)](https://www
 
 ## Installation
 
+<!-- start install -->
+
 While installing Manim Slides and its dependencies on your global Python is fine, I recommend using a virtual environment (e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.
 
 ### Dependencies
 
+<!-- start deps -->
+
 Manim Slides requires either Manim or ManimGL to be installed. Having both packages installed is fine too.
 
 If none of those packages are installed, please refer to their specific installation guidelines:
 - [Manim](https://docs.manim.community/en/stable/installation.html)
 - [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)
 
+<!-- end deps -->
+
 ### Pip Install
 
 The recommended way to install the latest release is to use pip:
@@ -45,26 +56,22 @@ pip install manim-slides
 
 ### Install From Repository
 
-An alternative way to install Manim Slides is to clone the git repository, and install from there:
+An alternative way to install Manim Slides is to clone the git repository, and install from there: read the [contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html) to know how.
 
-```bash
+<!-- end install -->
-git clone https://github.com/jeertmans/manim-slides
-pip install -e .
-```
-
-> *Note:* the `-e` flag allows you to edit the files, and observe the changes directly when using Manim Slides
 
 ## Usage
 
+<!-- start usage -->
+
 Using Manim Slides is a two-step process:
-1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead of `Scene` (resp. `ThreeDScene`), and add calls to `self.pause()` everytime you want to create a new slide.
+1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead of `Scene` (resp. `ThreeDScene`), and add calls to `self.next_slide()` everytime you want to create a new slide.
 2. Run `manim-slides` on rendered animations and display them like a *Power Point* presentation.
 
-The command-line documentation is available [online](https://eertmans.be/manim-slides/).
+The documentation is available [online](https://eertmans.be/manim-slides/).
 
 ### Basic Example
 
-
 Wrap a series of animations between `self.start_loop()` and `self.stop_loop()` when you want to loop them (until input to continue):
 
 ```python
@@ -74,32 +81,28 @@ from manim import *
 # or: from manimlib import *
 from manim_slides import Slide
 
-class Example(Slide):
+class BasicExample(Slide):
     def construct(self):
         circle = Circle(radius=3, color=BLUE)
         dot = Dot()
 
         self.play(GrowFromCenter(circle))
-        self.pause()  # Waits user to press continue to go to the next slide
+        self.next_slide()  # Waits user to press continue to go to the next slide
 
         self.start_loop()  # Start loop
         self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
         self.end_loop()  # This will loop until user inputs a key
 
         self.play(dot.animate.move_to(ORIGIN))
-        self.pause()  # Waits user to press continue to go to the next slide
+        self.next_slide()  # Waits user to press continue to go to the next slide
-
-        self.wait()
 ```
 
-You **must** end your `Slide` with a `self.play(...)` or a `self.wait(...)`.
-
 First, render the animation files:
 
 ```bash
-manim example.py
+manim example.py BasicExample
 # or
-manimgl example.py
+manimgl example.py BasicExample
 ```
 
 To start the presentation using `Scene1`, `Scene2` and so on simply run:
@@ -111,14 +114,20 @@ manim-slides [OPTIONS] Scene1 Scene2...
 Or in this example:
 
 ```bash
-manim-slides Example
+manim-slides BasicExample
 ```
 
+<!-- end usage -->
+
 ##  Key Bindings
 
 The default key bindings to control the presentation are:
 
-![manim-wizard](https://user-images.githubusercontent.com/27275099/197468787-19c83a81-d757-47b9-8f68-218427d30298.png)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
+  <img alt="Manim Slides Wizard" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/wizard_light.png">
+</picture>
 
 
 You can run the **configuration wizard** to change those key bindings:
@@ -179,8 +188,11 @@ in *Settings*->*Display*.
 
 ## Contributing
 
-Contributions are more than welcome!
+Contributions are more than welcome! Please read through [our contributing section](https://eertmans.be/manim-slides/contributing/index.html).
 
 [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
+[pypi-download-badge]: https://img.shields.io/pypi/dm/manim-slides
+[documentation-badge]: https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=documentation&up_color=green&up_message=online&url=https%3A%2F%2Feertmans.be%2Fmanim-slides%2F
+[documentation-url]: https://eertmans.be/manim-slides/

docs/source/_static/logo.png

@@ -0,0 +1 @@
+../../../static/logo.png

docs/source/_static/logo_dark_docs.png

@@ -0,0 +1 @@
+../../../static/logo_dark_docs.png

docs/source/_static/logo_dark_github.png

@@ -0,0 +1 @@
+../../../static/logo_dark_github.png

docs/source/_static/logo_dark_transparent.png

@@ -0,0 +1 @@
+../../../static/logo_dark_transparent.png

docs/source/_static/logo_light_transparent.png

@@ -0,0 +1 @@
+../../../static/logo_light_transparent.png

docs/source/_static/wizard_dark.png

@@ -0,0 +1 @@
+../../../static/wizard_dark.png

docs/source/_static/wizard_light.png

@@ -0,0 +1 @@
+../../../static/wizard_light.png

docs/source/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Changes between releases are listed in Manim Slides' [Github releases](https://github.com/jeertmans/manim-slides/releases). You can read the [latest release here](https://github.com/jeertmans/manim-slides/releases).

docs/source/conf.py

@@ -8,13 +8,26 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Manim Slides"
-copyright = "2022, Jérome Eertmans"
+copyright = "2023, Jérome Eertmans"
 author = "Jérome Eertmans"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc", "sphinx_click"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinxext.opengraph",
+    "sphinx_click",
+    "myst_parser",
+    "sphinx_copybutton",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
+    "html_admonition",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []
@@ -25,3 +38,36 @@ exclude_patterns = []
 
 html_theme = "furo"
 html_static_path = ["_static"]
+
+html_theme_options = {
+    "light_logo": "logo_light_transparent.png",
+    "dark_logo": "logo_dark_transparent.png",
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/jeertmans/manim-slides",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    "source_repository": "https://github.com/jeertmans/manim-slides/",
+    "source_branch": "main",
+    "source_directory": "docs/source/",
+}
+
+# -- Intersphinx mapping
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "manim": ("https://docs.manim.community/en/stable/", None),
+    "manimlib": ("https://3b1b.github.io/manim/", None),
+}
+
+# -- OpenGraph settings
+
+ogp_site_url = "https://eertmans.be/manim-slides/"
+ogp_use_first_image = True

docs/source/contributing/index.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thank you for your interest in Manim Slides! ✨
+
+Manim Slides is an open source project, first created as a fork of [manim-presentation](https://github.com/galatolofederico/manim-presentation) (now deprecated in favor to Manim Slides), and we welcome contributions of all forms.
+
+This section is here to help fist-time contributors know how they can help this project grow. Whether you are already familiar with Manim or GitHub, it is worth taking a few minutes to read those documents!
+
+
+```{toctree}
+:hidden:
+
+workflow
+internals
+```
+
+[Workflow](./workflow)
+: how to work on this project. Start here if you're a new contributor.
+
+[Internals](./internals)
+: how Manim Slides is built and how the various parts of it work.

docs/source/contributing/internals.md

@@ -0,0 +1,11 @@
+# Internals
+
+Manim-Slides' work in split in two steps: first, when rendering animation, and, second, when converting multiple animations into one slides presentation.
+
+## Rendering
+
+To render animations, Manim Slides simply uses Manim or ManimGL, and creates some additional output files that it needs for the presentation.
+
+## Slides presentation
+
+Manim Slides searches for the local artifacts it generated previously, and concatenates them into one presentation. For the graphical interface, it uses `PySide6`.

docs/source/contributing/workflow.md

@@ -0,0 +1,57 @@
+# Workflow
+
+This document is there to help you recreate a working environment for Manim Slides.
+
+## Dependencies
+
+```{include} ../../../README.md
+:start-after: <!-- start deps -->
+:end-before: <!-- end deps -->
+```
+
+## Forking the repository and cloning it locally
+
+We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
+
+Useful links:
+
+* [GitHub's Hello World](https://docs.github.com/en/get-started/quickstart/hello-world).
+* [GitHub Pull Request in 100 Seconds](https://www.youtube.com/watch?v=8lGpZkjnkt4&ab_channel=Fireship).
+
+Once you feel comfortable with git and GitHub, [fork](https://github.com/jeertmans/manim-slides/fork) the repository, and clone it locally.
+
+As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). If not already, please install it.
+
+## Installing Python modules
+
+With Poetry, installation becomes straightforward:
+
+```bash
+poetry install
+```
+
+## Running commands
+
+As modules were installed in a new Python environment, you cannot use them directly in the shell.
+Instead, you either need to prepend `poetry run` to any command, e.g.:
+
+```bash
+poetry run manim-slides wizard
+```
+
+or enter a new shell that uses this new Python environment:
+
+```
+poetry shell
+manim-slides wizard
+```
+
+## Testing your code
+
+Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is `pre-commit run --all-files`: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
+
+## Proposing changes
+
+Once you feel ready and think your contribution is ready to be reviewed, create a [pull request](https://github.com/jeertmans/manim-slides/pulls) and wait for a reviewer to check your work!
+
+Many thanks to you!

docs/source/features_table.md

@@ -0,0 +1,27 @@
+# Features Table
+
+The following summarizes the different presentation features Manim Slides offers.
+
+:::{table} Comparison of the different presentation methods.
+:widths: auto
+:align: center
+
+| Feature / Constraint | [`present`](reference/cli.md) | [`convert --to=html`](reference/cli.md) | [`convert --to=pptx`](reference/cli.md) |
+| :--- | :---: | :---: | :---: |
+| Basic navigation through slides | Yes | Yes | Yes |
+| Replay slide | Yes | No | No |
+| Pause animation | Yes | No | No |
+| Play slide in reverse | Yes | No | No |
+| Slide count | Yes | Yes (optional) | Yes (optional) |
+| Animation count | Yes | No | No |
+| Needs Python with Manim Slides installed | Yes | No | No |
+| Requires internet access | No | Yes | No |
+| Auto. play slides | Yes | Yes | Yes |
+| Loops support | Yes | Yes | Yes |
+| Fully customizable | No | Yes (`--use-template` option) | No |
+| Other dependencies | None | A modern web browser | PowerPoint or LibreOffice Impress[^1]
+| Works cross-platforms | Yes | Yes | Partly[^1][^2] |
+:::
+
+[^1]: If you encounter a problem where slides do not automatically play or loops do not work, please [file an issue on GitHub](https://github.com/jeertmans/manim-slides/issues/new/choose).
+[^2]: PowerPoint online does not seem to support automatic playing of videos, so you need LibreOffice Impress on Linux platforms.

docs/source/index.md

@@ -0,0 +1,52 @@
+---
+hide-toc: true
+og:description: Manim Slides makes creating slides with Manim super easy!
+---
+
+```{eval-rst}
+.. image:: _static/logo_light_transparent.png
+    :width: 600px
+    :align: center
+    :class: only-light
+    :alt: Manim Slide logo
+```
+
+```{eval-rst}
+.. image:: _static/logo_dark_transparent.png
+    :width: 600px
+    :align: center
+    :class: only-dark
+    :alt: Manim Slide logo
+```
+
+# Welcome to Manim Slide's documentation
+
+Manim Slides makes creating slides with Manim super easy!
+
+In a [very few steps](./quickstart), you can create slides and present them either using the GUI, or your browser.
+
+
+Slide through the demo below to get a quick glimpse on what you can do with Manin Slides.
+
+
+<!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
+
+
+```{toctree}
+:hidden:
+
+quickstart
+reference/index
+features_table
+```
+
+```{toctree}
+:caption: Development
+:hidden:
+
+contributing/index
+changelog
+license
+```

docs/source/index.rst

@@ -1,28 +0,0 @@
-.. manim-slides documentation master file, created by
-   sphinx-quickstart on Wed Sep 21 15:07:28 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: _static/logo.png
-    :width: 600px
-    :align: center
-    :alt: Manim Slide logo
-
-Welcome to Manim Slide's CLI documentation!
-===========================================
-
-
-.. raw:: html
-
-   <!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
-
-   <div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
-
-
-This page contains an exhaustive list of all the commands available with `manim-slides`.
-
-If you need help installing or using Manim Slide, please refer to the `GitHub README <https://github.com/jeertmans/manim-slides>`_.
-
-.. click:: manim_slides.__main__:cli
-    :prog: manim-slides
-    :nested: full

docs/source/license.md

@@ -0,0 +1,5 @@
+# License
+
+
+```{include} ../../LICENSE.md
+```

docs/source/quickstart.md

@@ -0,0 +1,21 @@
+# Quickstart
+
+## Installation
+
+```{include} ../../README.md
+:start-after: <!-- start install -->
+:end-before: <!-- end install -->
+```
+
+## Creating your first slides
+
+```{include} ../../README.md
+:start-after: <!-- start usage -->
+:end-before: <!-- end usage -->
+```
+
+The output slides should look this this:
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/basic_example.html"></iframe></div>
+
+For more advanced examples, see the [Examples](reference/examples) section.

docs/source/reference/api.md

@@ -0,0 +1,13 @@
+# Application Programming Interface
+
+Manim Slides' API is very limited: it simply consists in two classes, `Slide` and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim.
+
+Thefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering.
+
+```{eval-rst}
+.. autoclass:: manim_slides.Slide
+    :members: start_loop, end_loop, pause, next_slide
+
+.. autoclass:: manim_slides.ThreeDSlide
+    :members:
+```

docs/source/reference/cli.md

@@ -0,0 +1,10 @@
+# Command Line Interface
+
+This page contains an exhaustive list of all the commands available with `manim-slides`.
+
+
+```{eval-rst}
+.. click:: manim_slides.__main__:cli
+    :prog: manim-slides
+    :nested: full
+```

docs/source/reference/examples.md

@@ -0,0 +1,80 @@
+# Examples
+
+Contents of `example.py`.
+
+Do not forget to import Manim Slides and Manim or ManimGL:
+
+```python
+from manim import *
+from manim_slides import Slide, ThreeDSlide
+```
+
+or
+
+```python
+from manimlib import *
+from manim_slides import Slide, ThreeDSlide
+```
+
+Then, each presentation, named `SCENE`, was generated with those two commands:
+
+```bash
+manim example.py SCENE # or manimgl example SCENE
+manim-slides convert SCENE scene.html -ccontrols=true
+```
+
+where `-ccontrols=true` indicates that we want to display the blue navigation arrows.
+
+## Basic Example
+
+Basic example from quickstart.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/basic_example.html"></iframe></div>
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: BasicExample
+```
+
+## 3D Example
+
+Example using 3D camera. As Manim and ManimGL handle 3D differently, definitions are slightly different.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/three_d_example.html"></iframe></div>
+
+### With Manim
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manim-3d]
+   :end-before: [manim-3d]
+```
+
+### With ManimGL
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manimgl-3d]
+   :end-before: [manimgl-3d]
+```
+
+## Advanced Example
+
+A more advanced example is `ConvertExample`, which is used as demo slide and tutorial.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/slides.html"></iframe></div>
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: ConvertExample
+```

docs/source/reference/gui.md

@@ -0,0 +1,71 @@
+# Graphical User Interface
+
+Manim Slides' graphical user interface (GUI) is the *de facto* way to present slides.
+
+If you do not specify one of the commands listed in the [CLI reference](./cli),
+Manim Slides will use **present** by default, which launches a GUI window,
+playing your scene(s) like so:
+
+```bash
+manim-slides [present] [SCENES]...
+```
+
+Some optional parameters can be specified and can be listed with:
+
+```bash
+manim-slides present --help
+```
+
+:::{note}
+All the `SCENES` must be in the same folder (`--folder DIRECTORY`), which
+defaults to `./slides`. If you rendered your animations without changing
+directory, you should not worry about that :-)
+:::
+
+## Configuration File
+
+It is possible to configure Manim Slides via a configuration file, even though
+this feature is currently limited. You may initiliaze the default configuration
+file with:
+
+```bash
+manim-slides init
+```
+
+:::{warning}
+Note that, by default, Manim Slides will use default key bindings that are
+platform-dependent. If you decide to overwrite those with a config file, you may
+encounter some problems from platform to platform.
+:::
+
+## Configuring Key Bindings
+
+If you wish to use other key bindings than the defaults, you can run the
+configuration wizard with:
+
+```bash
+manim-slides wizard
+```
+
+A similar window to the image below will pop up and prompt to change keys.
+
+```{eval-rst}
+.. image:: ../_static/wizard_light.png
+    :width: 300px
+    :align: center
+    :class: only-light
+    :alt: Manim Slide Wizard
+```
+
+```{eval-rst}
+.. image:: ../_static/wizard_dark.png
+    :width: 300px
+    :align: center
+    :class: only-dark
+    :alt: Manim Slide Wizard
+```
+
+:::{note}
+Even though it is not currently supported through the GUI, you can select
+multiple key binding for the same action by modifying the config file.
+:::

docs/source/reference/html.md

@@ -0,0 +1,40 @@
+# HTML Presentations
+
+Manim Slides allows you to convert presentations into one HTML file, with
+[RevealJS](https://revealjs.com/). This file can then be opened with any modern
+web browser, allowing for a nice portability of your presentations.
+
+As for every command with Manim Slides, converting slides' fragments into one
+HTML file (and its assets) can be done in one command:
+
+```bash
+manim-slides convert [SCENES]... DEST
+```
+
+where `DEST` is the `.html` destination file.
+
+## Configuring the Template
+
+Many configuration options are available through the `-c<option>=<value>` syntax.
+Most, if not all, RevealJS options should be available by default. If that is
+not the case, please
+[fill an issue](https://github.com/jeertmans/manim-slides/issues/new/choose)
+on GitHub.
+
+You can print the list of available options with:
+
+```bash
+manim-slides convert --show-config
+```
+
+## Using a Custom Template
+
+The default template used for HTML conversion can be found on
+[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/data/revealjs_template.html)
+or printed with the `--show-template` option.
+If you wish to use another template, you can do so with the
+`--use-template FILE` option.
+
+## More about HTML Slides
+
+You can read more about HTML slides in the [sharing](./sharing) section.

docs/source/reference/index.md

@@ -0,0 +1,28 @@
+# Reference Documentation
+
+Automatically generated reference for Manim Slides.
+
+```{toctree}
+:hidden:
+
+api
+cli
+examples
+gui
+html
+sharing
+```
+
+[Application Programming Interface](./api): list of classes and methods that may
+be useful to the end-user.
+
+[Command Line Interface](./cli): list of all commands available using Manim
+Slides' executable.
+
+[Examples](./examples): curated list of examples and their output.
+
+[Graphical User Interface](./gui): details about the main Manim Slide' feature.
+
+[HTML Presenetation](./html): an alternative way of presenting your animations.
+
+[Sharing](./sharing): how to share your presentation with others.

docs/source/reference/sharing.md

@@ -0,0 +1,163 @@
+# Sharing your slides
+
+Maybe one of the most important features is the ability to share your
+presentation with other people, or even with yourself but on another computer!
+
+There exists a variety of solutions, and all of them are exposed here.
+
+We will go from the *most restrictive* method, to the least restrictive one.
+If you need to present on a computer without prior knowledge on what will be
+installed on it, please directly refer to the last sections.
+
+> **NOTES:** in the next sections, we will assume your animations are described
+in `example.py`, and you have one presentation called `BasicExample`.
+
+## With Manim Slides installed on the target machine
+
+If Manim Slides, Manim (or ManimGL), and their dependencies are installed, then
+using `manim-slides present` allows for the best presentations, with the most
+options available.
+
+### Sharing your Python file(s)
+
+The lightest way to share your presentation is with the Python files that
+describe the slides.
+
+If you have such files, you can recompile the animations locally, and use
+`manim-slides present` for your presentation. You may want to copy / paste
+you own `.manim-slides.json` config file, but it is **not recommended** if
+you are sharing from one platform (e.g., Linux) to another (e.g., Windows) as
+the key bindings might not be the same.
+
+Example:
+
+```bash
+# If you use ManimGl, replace `manim` with `manimgl`
+manim example.py BasicExample
+
+# This or `manim-slides BasicExample` works since
+# `present` is implied by default
+manim-slides present BasicExample
+```
+
+### Sharing your animations files
+
+If you do not want to recompile all the animations, you can simply share the
+slides folder (defaults to `./slides`). Then, Manim Slides will be able to read
+the animations from this folder and its subdirectories.
+
+Example:
+
+```bash
+# Make sure that the slides directory is in the current
+# working directory, or specify with `--folder <FOLDER>`
+manim-slides present BasicExample
+```
+
+and the corresponding tree:
+
+```
+.
+└── slides
+    ├── BasicExample.json
+    └── files
+        └── BasicExample (files not shown)
+```
+
+## Without Manim Slides installed on the target machine
+
+An alternative to `manim-slides present` is `manim-slides convert`.
+Currently, only HTML conversion is available, but do not hesitate to propose
+other formats by creating a
+[Feature Request](https://github.com/jeertmans/manim-slides/issues/new/choose),
+or directly proposing a
+[Pull Request](https://github.com/jeertmans/manim-slides/compare).
+
+A major advantage of HTML files is that they can be opened cross-platform,
+granted one has a modern web browser (which is pretty standard).
+
+### Sharing HTML and animation files
+
+First, you need to create the HTML file and its assets directory.
+
+Example:
+
+```bash
+manim-slides convert BasicExample basic_example.html
+```
+
+Then, you need to copy the HTML files and its assets directory to target location,
+while keeping the relative path between the HTML and the assets the same. The
+easiest solution is to compress both the file and the directory into one ZIP,
+and to extract it to the desired location.
+
+By default, the assets directory will be named after the main HTML file, using `{basename}_assets`.
+
+Example:
+
+```
+.
+├── basic_example_assets
+│   ├── 1413466013_2261824125_223132457.mp4
+│   ├── 1672018281_2145352439_3942561600.mp4
+│   └── 1672018281_3136302242_2191168284.mp4
+└── basic_example.html
+```
+
+Then, you can simply open the HTML file with any web browser application.
+
+If you want to embed the presentation inside an HTML web page, a possibility is
+to use an `iframe`:
+
+```html
+<div style="position:relative;padding-bottom:56.25%;">
+    <!-- 56.25 comes from aspect ratio of 16:9, change this accordingly -->
+    <iframe
+        style="width:100%;height:100%;position:absolute;left:0px;top:0px;"
+        frameborder="0"
+        width="100%"
+        height="100%"
+        allowfullscreen
+        allow="autoplay"
+        src="basic_example.html">
+    </iframe>
+</div>
+```
+
+The additional code comes from
+[this article](https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page)
+and it there to preserve the original aspect ratio (16:9).
+
+
+### Sharing ONE HTML file
+
+A future feature, that will be available once
+[#122](https://github.com/jeertmans/manim-slides/issues/122) is solved, will be
+to include all animations as data URI encoded, within the HTML file itself.
+
+### Over the internet
+
+Finally, HTML conversion makes it convenient to play your presentation on a
+remote server.
+
+This is how your are able to watch all the examples on this website. If you want
+to know how to share your slide with GitHub pages, see the
+[workflow file](https://github.com/jeertmans/manim-slides/blob/main/.github/workflows/pages.yml).
+
+> **WARNING:** keep in mind that playing large video files over the internet
+can take some time, and *glitches* may occur between slide transitions for this
+reason.
+
+### With PowerPoint (*EXPERIMENTAL*)
+
+A recent conversion feature is to the PowerPoint format, thanks to the `python-pptx` package. Even though it is fully working, it is still considered in an *EXPERIMENTAL* status because we do not exactly know what versions of PowerPoint (or LibreOffice Impress) are supported.
+
+Basically, you can create a PowerPoint in a single command:
+
+```bash
+manim-slides convert --to=pptx BasicExample basic_example.pptx
+```
+
+All the videos and necessary files will be contained inside the `.pptx` file, so you can safely share it with anyone. By default, the `poster_frame_image`, i.e., what is displayed by PowerPoint when the video is not playing, is the first frame of each slide. This allows for smooth transitions.
+
+In the future, we hope to provide more features to this format, so feel free to suggest new features too!

example.py

@@ -16,30 +16,38 @@ else:
 from manim_slides import Slide, ThreeDSlide
 
 
-class Example(Slide):
+class BasicExample(Slide):
     def construct(self):
         circle = Circle(radius=3, color=BLUE)
         dot = Dot()
 
         self.play(GrowFromCenter(circle))
-        self.pause()
+        self.next_slide()  # Waits user to press continue to go to the next slide
 
-        self.start_loop()
+        self.start_loop()  # Start loop
         self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
+        self.end_loop()  # This will loop until user inputs a key
 
         self.play(dot.animate.move_to(ORIGIN))
-        self.pause()
+        self.next_slide()  # Waits user to press continue to go to the next slide
 
-        self.play(dot.animate.move_to(RIGHT * 3))
-        self.pause()
 
-        self.start_loop()
+class TestFileTooLong(Slide):
-        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
+    """This is used to check against solution for issue #123."""
-        self.end_loop()
 
-        # Each slide MUST end with an animation (a self.wait is considered an animation)
+    def construct(self):
-        self.play(dot.animate.move_to(ORIGIN))
+        import random
+
+        circle = Circle(radius=3, color=BLUE)
+        dot = Dot()
+        self.play(GrowFromCenter(circle), run_time=0.1)
+
+        for _ in range(30):
+            direction = (random.random() - 0.5) * LEFT + (random.random() - 0.5) * UP
+            self.play(dot.animate.move_to(direction), run_time=0.1)
+            self.play(dot.animate.move_to(ORIGIN), run_time=0.1)
+
+        self.next_slide()
 
 
 class ConvertExample(Slide):
@@ -49,7 +57,6 @@ class ConvertExample(Slide):
         self.wait(0.1)
 
     def construct(self):
-
         title = VGroup(
             Text("From Manim animations", t2c={"From": BLUE}),
             Text("to slides presentation", t2c={"to": BLUE}),
@@ -70,7 +77,7 @@ class ConvertExample(Slide):
 
         self.play(FadeIn(title))
 
-        self.pause()
+        self.next_slide()
 
         code = Code(
             code="""from manim import *
@@ -139,10 +146,10 @@ class Example(Slide):
         self.add(dot)
 
         self.play(Indicate(dot, scale_factor=2))
-        self.pause()
+        self.next_slide()
         square = Square()
         self.play(Transform(dot, square))
-        self.pause()
+        self.next_slide()
         self.play(Rotate(square, angle=PI/2))
 """,
             language="python",
@@ -161,7 +168,7 @@ class Example(Slide):
         self.end_loop()
         square = Square()
         self.play(Transform(dot, square))
-        self.pause()
+        self.next_slide()
         self.play(Rotate(square, angle=PI/2))
 """,
             language="python",
@@ -188,38 +195,38 @@ class Example(Slide):
 
         self.play(FadeIn(code))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(FadeIn(step, shift=RIGHT))
         self.play(Transform(code, code_step_1))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(Transform(step, step_2))
         self.play(Transform(code, code_step_2))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(Transform(step, step_3))
         self.play(Transform(code, code_step_3))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(Transform(step, step_4))
         self.play(Transform(code, code_step_4))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(Transform(step, step_5))
         self.play(Transform(code, code_step_5))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         self.play(Transform(step, step_6))
         self.play(Transform(code, code_step_6))
         self.play(code.animate.shift(UP), FadeIn(code_step_7), FadeIn(or_text))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         watch_text = Text("Watch result on next slides!").shift(2 * DOWN).scale(0.5)
 
@@ -239,10 +246,10 @@ class Example(Slide):
         self.remove(dot)
         self.add(square)
         self.tinywait()
-        self.pause()
+        self.next_slide()
         self.play(Rotate(square, angle=PI / 4))
         self.tinywait()
-        self.pause()
+        self.next_slide()
 
         learn_more_text = (
             VGroup(
@@ -260,7 +267,7 @@ class Example(Slide):
 # For ThreeDExample, things are different
 
 if not MANIMGL:
-
+    # [manim-3d]
     class ThreeDExample(ThreeDSlide):
         def construct(self):
             axes = ThreeDAxes()
@@ -274,7 +281,7 @@ if not MANIMGL:
             self.play(GrowFromCenter(circle))
             self.begin_ambient_camera_rotation(rate=75 * DEGREES / 4)
 
-            self.pause()
+            self.next_slide()
 
             self.start_loop()
             self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
@@ -284,19 +291,20 @@ if not MANIMGL:
             self.move_camera(phi=75 * DEGREES, theta=30 * DEGREES)
 
             self.play(dot.animate.move_to(ORIGIN))
-            self.pause()
+            self.next_slide()
 
             self.play(dot.animate.move_to(RIGHT * 3))
-            self.pause()
+            self.next_slide()
 
             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-3d]
 else:
+    # [manimgl-3d]
     # WARNING: 3b1b's manim change how ThreeDScene work,
     # this is why things have to be managed differently.
     class ThreeDExample(Slide):
@@ -322,7 +330,7 @@ else:
             updater = lambda m, dt: m.increment_theta((75 * DEGREES / 4) * dt)
             frame.add_updater(updater)
 
-            self.pause()
+            self.next_slide()
 
             self.start_loop()
             self.play(MoveAlongPath(dot, circle), run_time=4, rate_func=linear)
@@ -331,14 +339,15 @@ else:
             frame.remove_updater(updater)
             self.play(frame.animate.set_theta(30 * DEGREES))
             self.play(dot.animate.move_to(ORIGIN))
-            self.pause()
+            self.next_slide()
 
             self.play(dot.animate.move_to(RIGHT * 3))
-            self.pause()
+            self.next_slide()
 
             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))
+
+    # [manimgl-3d]

manim_slides/__init__.py

@@ -1,3 +1,48 @@
 # flake8: noqa: F401
+import sys
+from types import ModuleType
+from typing import Any, List
+
 from .__version__ import __version__
-from .slide import Slide, ThreeDSlide
+
+
+class module(ModuleType):
+    def __getattr__(self, name: str) -> Any:
+        if name == "Slide" or name == "ThreeDSlide":
+            module = __import__(
+                "manim_slides.slide", None, None, ["Slide", "ThreeDSlide"]
+            )
+            return getattr(module, name)
+
+        return ModuleType.__getattribute__(self, name)
+
+    def __dir__(self) -> List[str]:
+        result = list(new_module.__all__)
+        result.extend(
+            (
+                "__file__",
+                "__doc__",
+                "__all__",
+                "__docformat__",
+                "__name__",
+                "__path__",
+                "__package__",
+                "__version__",
+            )
+        )
+        return result
+
+
+old_module = sys.modules["manim_slides"]
+new_module = sys.modules["manim_slides"] = module("manim_slides")
+
+new_module.__dict__.update(
+    {
+        "__file__": __file__,
+        "__package__": "manim_slides",
+        "__path__": __path__,
+        "__doc__": __doc__,
+        "__version__": __version__,
+        "__all__": ("__version__", "Slides", "ThreeDSlide"),
+    }
+)

manim_slides/__main__.py

@@ -4,9 +4,9 @@ import click
 import requests
 from click_default_group import DefaultGroup
 
-from . import __version__
+from .__version__ import __version__
 from .convert import convert
-from .manim import logger
+from .logger import make_logger
 from .present import list_scenes, present
 from .wizard import init, wizard
 
@@ -27,6 +27,7 @@ def cli(notify_outdated_version: bool) -> None:
 
     If no command is specified, defaults to `present`.
     """
+    logger = make_logger()
     # Code below is mostly a copy from:
     # https://github.com/ManimCommunity/manim/blob/main/manim/cli/render/commands.py
     if notify_outdated_version:

manim_slides/__version__.py

@@ -1 +1 @@
-__version__ = "4.8.1"
+__version__ = "4.10.0"

manim_slides/commons.py

@@ -1,10 +1,11 @@
+from pathlib import Path
 from typing import Any, Callable
 
 import click
 from click import Context, Parameter
 
 from .defaults import CONFIG_PATH, FOLDER_PATH
-from .manim import logger
+from .logger import logger
 
 F = Callable[..., Any]
 Wrapper = Callable[[F], F]
@@ -18,7 +19,7 @@ def config_path_option(function: F) -> F:
         "config_path",
         metavar="FILE",
         default=CONFIG_PATH,
-        type=click.Path(dir_okay=False),
+        type=click.Path(dir_okay=False, path_type=Path),
         help="Set path to configuration file.",
         show_default=True,
     )
@@ -44,7 +45,6 @@ def verbosity_option(function: F) -> F:
     """Wraps a function to add verbosity option."""
 
     def callback(ctx: Context, param: Parameter, value: bool) -> None:
-
         if not value or ctx.resilient_parsing:
             return
 
@@ -74,7 +74,7 @@ def folder_path_option(function: F) -> F:
         "--folder",
         metavar="DIRECTORY",
         default=FOLDER_PATH,
-        type=click.Path(exists=True, file_okay=False),
+        type=click.Path(exists=True, file_okay=False, path_type=Path),
         help="Set slides folder.",
         show_default=True,
     )

manim_slides/config.py

@@ -1,27 +1,37 @@
+import hashlib
 import os
 import shutil
 import subprocess
 import tempfile
 from enum import Enum
-from typing import Callable, Dict, List, Optional, Set, Union
+from pathlib import Path
+from typing import Dict, List, Optional, Set, Union
 
-from pydantic import BaseModel, root_validator, validator
+from pydantic import BaseModel, FilePath, root_validator, validator
 from PySide6.QtCore import Qt
 
-from .manim import FFMPEG_BIN, logger
+from .defaults import FFMPEG_BIN
+from .logger import logger
 
 
-def merge_basenames(files: List[str]) -> str:
+def merge_basenames(files: List[FilePath]) -> Path:
     """
     Merge multiple filenames by concatenating basenames.
     """
+    logger.info(f"Generating a new filename for animations: {files}")
 
-    dirname = os.path.dirname(files[0])
+    dirname = files[0].parent
-    _, ext = os.path.splitext(files[0])
+    ext = files[0].suffix
 
-    basename = "_".join(os.path.splitext(os.path.basename(file))[0] for file in files)
+    basenames = (file.stem for file in files)
 
-    return os.path.join(dirname, basename + ext)
+    basenames_str = ",".join(f"{len(b)}:{b}" for b in basenames)
+
+    # We use hashes to prevent too-long filenames, see issue #123:
+    # https://github.com/jeertmans/manim-slides/issues/123
+    basename = hashlib.sha256(basenames_str.encode()).hexdigest()
+
+    return dirname / (basename + ext)
 
 
 class Key(BaseModel):  # type: ignore
@@ -111,7 +121,6 @@ class SlideConfig(BaseModel):  # type: ignore
         cls, values: Dict[str, Union[SlideType, int, bool]]
     ) -> Dict[str, Union[SlideType, int, bool]]:
         if values["start_animation"] >= values["end_animation"]:  # type: ignore
-
             if values["start_animation"] == values["end_animation"] == 0:
                 raise ValueError(
                     "You have to play at least one animation (e.g., `self.wait()`) before pausing. If you want to start paused, use the approriate command-line option when presenting. IMPORTANT: when using ManimGL, `self.wait()` is not considered to be an animation, so prefer to directly use `self.play(...)`."
@@ -139,24 +148,12 @@ class SlideConfig(BaseModel):  # type: ignore
 
 class PresentationConfig(BaseModel):  # type: ignore
     slides: List[SlideConfig]
-    files: List[str]
+    files: List[FilePath]
-
-    @validator("files", pre=True, each_item=True)
-    def is_file_and_exists(cls, v: str) -> str:
-        if not os.path.exists(v):
-            raise ValueError(
-                f"Animation file {v} does not exist. Are you in the right directory?"
-            )
-
-        if not os.path.isfile(v):
-            raise ValueError(f"Animation file {v} is not a file")
-
-        return v
 
     @root_validator
     def animation_indices_match_files(
-        cls, values: Dict[str, Union[List[SlideConfig], List[str]]]
+        cls, values: Dict[str, Union[List[SlideConfig], List[FilePath]]]
-    ) -> Dict[str, Union[List[SlideConfig], List[str]]]:
+    ) -> Dict[str, Union[List[SlideConfig], List[FilePath]]]:
         files = values.get("files")
         slides = values.get("slides")
 
@@ -173,26 +170,26 @@ class PresentationConfig(BaseModel):  # type: ignore
 
         return values
 
-    def move_to(self, dest: str, copy: bool = True) -> "PresentationConfig":
+    def copy_to(self, dest: Path, use_cached: bool = True) -> "PresentationConfig":
         """
-        Moves (or copy) the files to a given directory.
+        Copy the files to a given directory.
         """
-        copy_func: Callable[[str, str], None] = shutil.copy
-        move_func: Callable[[str, str], None] = shutil.move
-        move = copy_func if copy else move_func
-
         n = len(self.files)
         for i in range(n):
             file = self.files[i]
-            basename = os.path.basename(file)
+            dest_path = dest / self.files[i].name
-            dest_path = os.path.join(dest, basename)
-            logger.debug(f"Moving / copying {file} to {dest_path}")
-            move(file, dest_path)
             self.files[i] = dest_path
+            if use_cached and dest_path.exists():
+                logger.debug(f"Skipping copy of {file}, using cached copy")
+                continue
+            logger.debug(f"Copying {file} to {dest_path}")
+            shutil.copy(file, dest_path)
 
         return self
 
-    def concat_animations(self, dest: Optional[str] = None) -> "PresentationConfig":
+    def concat_animations(
+        self, dest: Optional[Path] = None, use_cached: bool = True
+    ) -> "PresentationConfig":
         """
         Concatenate animations such that each slide contains one animation.
         """
@@ -202,14 +199,22 @@ class PresentationConfig(BaseModel):  # type: ignore
         for i, slide_config in enumerate(self.slides):
             files = self.files[slide_config.slides_slice]
 
+            slide_config.start_animation = i
+            slide_config.end_animation = i + 1
+
             if len(files) > 1:
                 dest_path = merge_basenames(files)
+                dest_paths.append(dest_path)
+
+                if use_cached and dest_path.exists():
+                    logger.debug(f"Concatenated animations already exist for slide {i}")
+                    continue
 
                 f = tempfile.NamedTemporaryFile(mode="w", delete=False)
                 f.writelines(f"file '{os.path.abspath(path)}'\n" for path in files)
                 f.close()
 
-                command = [
+                command: List[str] = [
                     FFMPEG_BIN,
                     "-f",
                     "concat",
@@ -219,7 +224,7 @@ class PresentationConfig(BaseModel):  # type: ignore
                     f.name,
                     "-c",
                     "copy",
-                    dest_path,
+                    str(dest_path),
                     "-y",
                 ]
                 logger.debug(" ".join(command))
@@ -234,18 +239,18 @@ class PresentationConfig(BaseModel):  # type: ignore
                 if error:
                     logger.debug(error.decode())
 
-                dest_paths.append(dest_path)
+                if not dest_path.exists():
+                    raise ValueError(
+                        "could not properly concatenate animations, use `-v INFO` for more details"
+                    )
 
             else:
                 dest_paths.append(files[0])
 
-            slide_config.start_animation = i
-            slide_config.end_animation = i + 1
-
         self.files = dest_paths
 
         if dest:
-            return self.move_to(dest)
+            return self.copy_to(dest)
 
         return self
 

manim_slides/convert.py

@@ -1,22 +1,42 @@
 import os
+import platform
+import subprocess
+import sys
+import tempfile
 import webbrowser
 from enum import Enum
+from importlib import resources
+from pathlib import Path
 from typing import Any, Callable, Dict, Generator, List, Optional, Type, Union
 
 import click
-import pkg_resources
+import cv2
+import pptx
 from click import Context, Parameter
-from pydantic import BaseModel, PositiveInt, ValidationError
+from lxml import etree
+from pydantic import BaseModel, FilePath, PositiveInt, ValidationError
+from tqdm import tqdm
 
+from . import data
 from .commons import folder_path_option, verbosity_option
 from .config import PresentationConfig
+from .logger import logger
 from .present import get_scenes_presentation_config
 
 
+def open_with_default(file: Path):
+    system = platform.system()
+    if system == "Darwin":
+        subprocess.call(("open", str(file)))
+    elif system == "Windows":
+        os.startfile(str(file))  # type: ignore[attr-defined]
+    else:
+        subprocess.call(("xdg-open", str(file)))
+
+
 def validate_config_option(
     ctx: Context, param: Parameter, value: Any
 ) -> Dict[str, str]:
-
     config = {}
 
     for c_option in value:
@@ -36,7 +56,7 @@ class Converter(BaseModel):  # type: ignore
     assets_dir: str = "{basename}_assets"
     template: Optional[str] = None
 
-    def convert_to(self, dest: str) -> None:
+    def convert_to(self, dest: Path) -> None:
         """Converts self, i.e., a list of presentations, into a given format."""
         raise NotImplementedError
 
@@ -46,7 +66,7 @@ class Converter(BaseModel):  # type: ignore
         An empty string is returned if no template is used."""
         return ""
 
-    def open(self, file: str) -> bool:
+    def open(self, file: Path) -> bool:
         """Opens a file, generated with converter, using appropriate application."""
         raise NotImplementedError
 
@@ -55,6 +75,7 @@ class Converter(BaseModel):  # type: ignore
         """Returns the appropriate converter from a string name."""
         return {
             "html": RevealJS,
+            "pptx": PowerPoint,
         }[s]
 
 
@@ -171,6 +192,13 @@ class TransitionSpeed(Str, Enum):  # type: ignore
     slow = "slow"
 
 
+class BackgroundSize(Str, Enum):  # type: ignore
+    # From: https://developer.mozilla.org/en-US/docs/Web/CSS/background-size
+    # TODO: support more background size
+    contain = "contain"
+    cover = "cover"
+
+
 BackgroundTransition = Transition
 
 
@@ -259,6 +287,7 @@ class RevealJS(Converter):
     focus_body_on_page_visibility_change: JsBool = JsBool.true
     transition: Transition = Transition.none
     transition_speed: TransitionSpeed = TransitionSpeed.default
+    background_size: BackgroundSize = BackgroundSize.contain  # Not in RevealJS
     background_transition: BackgroundTransition = BackgroundTransition.none
     pdf_max_pages_per_slide: Union[int, str] = "Number.POSITIVE_INFINITY"
     pdf_separate_fragments: JsBool = JsBool.true
@@ -278,12 +307,12 @@ class RevealJS(Converter):
         use_enum_values = True
         extra = "forbid"
 
-    def get_sections_iter(self) -> Generator[str, None, None]:
+    def get_sections_iter(self, assets_dir: Path) -> Generator[str, None, None]:
         """Generates a sequence of sections, one per slide, that will be included into the html template."""
         for presentation_config in self.presentation_configs:
             for slide_config in presentation_config.slides:
                 file = presentation_config.files[slide_config.start_animation]
-                file = os.path.join(self.assets_dir, os.path.basename(file))
+                file = assets_dir / file.name
 
                 # TODO: document this
                 # Videos are muted because, otherwise, the first slide never plays correctly.
@@ -292,40 +321,42 @@ class RevealJS(Converter):
                 # Read more about this:
                 #   https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide#autoplay_and_autoplay_blocking
                 if slide_config.is_loop():
-                    yield f'<section data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
+                    yield f'<section data-background-size={self.background_size.value} data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
                 else:
-                    yield f'<section data-background-video="{file}" data-background-video-muted></section>'
+                    yield f'<section data-background-size={self.background_size.value} data-background-video="{file}" data-background-video-muted></section>'
 
     def load_template(self) -> str:
         """Returns the RevealJS HTML template as a string."""
         if isinstance(self.template, str):
             with open(self.template, "r") as f:
                 return f.read()
-        return pkg_resources.resource_string(
-            __name__, "data/revealjs_template.html"
-        ).decode()
 
-    def open(self, file: str) -> bool:
+        if sys.version_info < (3, 9):
-        return webbrowser.open(file)
+            return resources.read_text(data, "revealjs_template.html")
 
-    def convert_to(self, dest: str) -> None:
+        return resources.files(data).joinpath("revealjs_template.html").read_text()
+
+    def open(self, file: Path) -> bool:
+        return webbrowser.open(file.absolute().as_uri())
+
+    def convert_to(self, dest: Path) -> None:
         """Converts this configuration into a RevealJS HTML presentation, saved to DEST."""
-        dirname = os.path.dirname(dest)
+        dirname = dest.parent
-        basename, ext = os.path.splitext(os.path.basename(dest))
+        basename = dest.stem
+        ext = dest.suffix
 
-        self.assets_dir = self.assets_dir.format(
+        assets_dir = Path(
-            dirname=dirname, basename=basename, ext=ext
+            self.assets_dir.format(dirname=dirname, basename=basename, ext=ext)
         )
-        full_assets_dir = os.path.join(dirname, self.assets_dir)
+        full_assets_dir = dirname / assets_dir
 
         os.makedirs(full_assets_dir, exist_ok=True)
 
         for presentation_config in self.presentation_configs:
-            presentation_config.concat_animations().move_to(full_assets_dir)
+            presentation_config.concat_animations().copy_to(full_assets_dir)
 
         with open(dest, "w") as f:
-
+            sections = "".join(self.get_sections_iter(assets_dir))
-            sections = "".join(self.get_sections_iter())
 
             revealjs_template = self.load_template()
             content = revealjs_template.format(sections=sections, **self.dict())
@@ -333,11 +364,94 @@ class RevealJS(Converter):
             f.write(content)
 
 
+class PowerPoint(Converter):
+    left: PositiveInt = 0
+    top: PositiveInt = 0
+    width: PositiveInt = 1280
+    height: PositiveInt = 720
+    auto_play_media: bool = True
+    poster_frame_image: Optional[FilePath] = None
+
+    class Config:
+        use_enum_values = True
+        extra = "forbid"
+
+    def open(self, file: Path) -> bool:
+        return open_with_default(file)
+
+    def convert_to(self, dest: Path) -> None:
+        """Converts this configuration into a PowerPoint presentation, saved to DEST."""
+        prs = pptx.Presentation()
+        prs.slide_width = self.width * 9525
+        prs.slide_height = self.height * 9525
+
+        layout = prs.slide_layouts[6]  # Should be blank
+
+        # From GitHub issue comment:
+        # - https://github.com/scanny/python-pptx/issues/427#issuecomment-856724440
+        def auto_play_media(media: pptx.shapes.picture.Movie, loop: bool = False):
+            el_id = xpath(media.element, ".//p:cNvPr")[0].attrib["id"]
+            el_cnt = xpath(
+                media.element.getparent().getparent().getparent(),
+                './/p:timing//p:video//p:spTgt[@spid="%s"]' % el_id,
+            )[0]
+            cond = xpath(el_cnt.getparent().getparent(), ".//p:cond")[0]
+            cond.set("delay", "0")
+
+            if loop:
+                ctn = xpath(el_cnt.getparent().getparent(), ".//p:cTn")[0]
+                ctn.set("repeatCount", "indefinite")
+
+        def xpath(el: etree.Element, query: str) -> etree.XPath:
+            nsmap = {"p": "http://schemas.openxmlformats.org/presentationml/2006/main"}
+            return etree.ElementBase.xpath(el, query, namespaces=nsmap)
+
+        def save_first_image_from_video_file(file: Path) -> Optional[str]:
+            cap = cv2.VideoCapture(str(file))
+            ret, frame = cap.read()
+
+            if ret:
+                f = tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".png")
+                cv2.imwrite(f.name, frame)
+                return f.name
+            else:
+                logger.warn("Failed to read first image from video file")
+                return None
+
+        for i, presentation_config in enumerate(self.presentation_configs):
+            presentation_config.concat_animations()
+            for slide_config in tqdm(
+                presentation_config.slides,
+                desc=f"Generating video slides for config {i + 1}",
+                leave=False,
+            ):
+                file = presentation_config.files[slide_config.start_animation]
+
+                if self.poster_frame_image is None:
+                    poster_frame_image = save_first_image_from_video_file(file)
+                else:
+                    poster_frame_image = str(self.poster_frame_image)
+
+                slide = prs.slides.add_slide(layout)
+                movie = slide.shapes.add_movie(
+                    str(file),
+                    self.left,
+                    self.top,
+                    self.width * 9525,
+                    self.height * 9525,
+                    poster_frame_image=poster_frame_image,
+                    mime_type="video/mp4",
+                )
+                if self.auto_play_media:
+                    auto_play_media(movie, loop=slide_config.is_loop())
+
+        prs.save(dest)
+
+
 def show_config_options(function: Callable[..., Any]) -> Callable[..., Any]:
     """Wraps a function to add a `--show-config` option."""
 
     def callback(ctx: Context, param: Parameter, value: bool) -> None:
-
         if not value or ctx.resilient_parsing:
             return
 
@@ -364,7 +478,6 @@ def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
     """Wraps a function to add a `--show-template` option."""
 
     def callback(ctx: Context, param: Parameter, value: bool) -> None:
-
         if not value or ctx.resilient_parsing:
             return
 
@@ -392,10 +505,10 @@ def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
 @click.command()
 @click.argument("scenes", nargs=-1)
 @folder_path_option
-@click.argument("dest")
+@click.argument("dest", type=click.Path(dir_okay=False, path_type=Path))
 @click.option(
     "--to",
-    type=click.Choice(["html"], case_sensitive=False),
+    type=click.Choice(["html", "pptx"], case_sensitive=False),
     default="html",
     show_default=True,
     help="Set the conversion format to use.",
@@ -419,7 +532,7 @@ def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
     "--use-template",
     "template",
     metavar="FILE",
-    type=click.Path(exists=True, dir_okay=False),
+    type=click.Path(exists=True, dir_okay=False, path_type=Path),
     help="Use the template given by FILE instead of default one. To echo the default template, use `--show-template`.",
 )
 @show_template_option
@@ -427,13 +540,13 @@ def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
 @verbosity_option
 def convert(
     scenes: List[str],
-    folder: str,
+    folder: Path,
-    dest: str,
+    dest: Path,
     to: str,
     open_result: bool,
     force: bool,
     config_options: Dict[str, str],
-    template: Optional[str],
+    template: Optional[Path],
 ) -> None:
     """
     Convert SCENE(s) into a given format and writes the result in DEST.
@@ -454,7 +567,6 @@ def convert(
             converter.open(dest)
 
     except ValidationError as e:
-
         errors = e.errors()
 
         msg = [

manim_slides/defaults.py

@@ -1,2 +1,3 @@
 FOLDER_PATH: str = "./slides"
 CONFIG_PATH: str = ".manim-slides.json"
+FFMPEG_BIN: str = "ffmpeg"

manim_slides/logger.py

@@ -0,0 +1,42 @@
+"""
+Logger utils, mostly copied from Manim Community:
+https://github.com/ManimCommunity/manim/blob/d5b65b844b8ce8ff5151a2f56f9dc98cebbc1db4/manim/_config/logger_utils.py#L29-L101
+"""
+
+import logging
+
+from rich.logging import RichHandler
+
+__all__ = ["logger", "make_logger"]
+
+HIGHLIGHTED_KEYWORDS = [  # these keywords are highlighted specially
+    "Played",
+    "animations",
+    "scene",
+    "Reading",
+    "Writing",
+    "script",
+    "arguments",
+    "Invalid",
+    "Aborting",
+    "module",
+    "File",
+    "Rendering",
+    "Rendered",
+]
+
+
+def make_logger() -> logging.Logger:
+    """
+    Make a logger similar to the one used by Manim.
+    """
+    RichHandler.KEYWORDS = HIGHLIGHTED_KEYWORDS
+    rich_handler = RichHandler(
+        show_time=True,
+    )
+    logger = logging.getLogger("manim-slides")
+    logger.addHandler(rich_handler)
+    return logger
+
+
+logger = logging.getLogger("manim-slides")

manim_slides/present.py

@@ -3,6 +3,7 @@ import platform
 import sys
 import time
 from enum import Enum, IntEnum, auto, unique
+from pathlib import Path
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import click
@@ -17,7 +18,7 @@ from tqdm import tqdm
 from .commons import config_path_option, verbosity_option
 from .config import DEFAULT_CONFIG, Config, PresentationConfig, SlideConfig
 from .defaults import FOLDER_PATH
-from .manim import logger
+from .logger import logger
 from .resources import *  # noqa: F401, F403
 
 os.environ.pop(
@@ -114,7 +115,6 @@ class Presentation:
         if (self.loaded_animation_cap != animation) or (
             self.reverse and self.reversed_animation != animation
         ):  # cap already loaded
-
             logger.debug(f"Loading new cap for animation #{animation}")
 
             self.release_cap()
@@ -127,7 +127,7 @@ class Presentation:
 
             self.current_file = file
 
-            self.cap = cv2.VideoCapture(file)
+            self.cap = cv2.VideoCapture(str(file))
             self.loaded_animation_cap = animation
 
     @property
@@ -575,7 +575,6 @@ class App(QWidget):  # type: ignore
         self.thread.start()
 
     def keyPressEvent(self, event: QKeyEvent) -> None:
-
         key = event.key()
         if self.config.HIDE_MOUSE.match(key):
             if self.hide_mouse:
@@ -628,41 +627,41 @@ class App(QWidget):  # type: ignore
     "--folder",
     metavar="DIRECTORY",
     default=FOLDER_PATH,
-    type=click.Path(exists=True, file_okay=False),
+    type=click.Path(exists=True, file_okay=False, path_type=Path),
     help="Set slides folder.",
     show_default=True,
 )
 @click.help_option("-h", "--help")
 @verbosity_option
-def list_scenes(folder: str) -> None:
+def list_scenes(folder: Path) -> None:
     """List available scenes."""
 
     for i, scene in enumerate(_list_scenes(folder), start=1):
         click.secho(f"{i}: {scene}", fg="green")
 
 
-def _list_scenes(folder: str) -> List[str]:
+def _list_scenes(folder: Path) -> List[str]:
     """Lists available scenes in given directory."""
     scenes = []
 
-    for file in os.listdir(folder):
+    for filepath in folder.glob("*.json"):
-        if file.endswith(".json"):
+        try:
-            filepath = os.path.join(folder, file)
+            _ = PresentationConfig.parse_file(filepath)
-            try:
+            scenes.append(filepath.stem)
-                _ = PresentationConfig.parse_file(filepath)
+        except (
-                scenes.append(os.path.basename(file)[:-5])
+            Exception
-            except Exception as e:  # Could not parse this file as a proper presentation config
+        ) as e:  # Could not parse this file as a proper presentation config
-                logger.warn(
+            logger.warn(
-                    f"Something went wrong with parsing presentation config `{filepath}`: {e}"
+                f"Something went wrong with parsing presentation config `{filepath}`: {e}"
-                )
+            )
-                pass
+            pass
 
     logger.debug(f"Found {len(scenes)} valid scene configuration files in `{folder}`.")
 
     return scenes
 
 
-def prompt_for_scenes(folder: str) -> List[str]:
+def prompt_for_scenes(folder: Path) -> List[str]:
     """Prompts the user to select scenes within a given folder."""
 
     scene_choices = dict(enumerate(_list_scenes(folder), start=1))
@@ -697,7 +696,7 @@ def prompt_for_scenes(folder: str) -> List[str]:
 
 
 def get_scenes_presentation_config(
-    scenes: List[str], folder: str
+    scenes: List[str], folder: Path
 ) -> List[PresentationConfig]:
     """Returns a list of presentation configurations based on the user input."""
 
@@ -706,8 +705,8 @@ def get_scenes_presentation_config(
 
     presentation_configs = []
     for scene in scenes:
-        config_file = os.path.join(folder, f"{scene}.json")
+        config_file = folder / f"{scene}.json"
-        if not os.path.exists(config_file):
+        if not config_file.exists():
             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"
             )
@@ -726,7 +725,7 @@ def get_scenes_presentation_config(
     "--folder",
     metavar="DIRECTORY",
     default=FOLDER_PATH,
-    type=click.Path(exists=True, file_okay=False),
+    type=click.Path(exists=True, file_okay=False, path_type=Path),
     help="Set slides folder.",
     show_default=True,
 )
@@ -752,7 +751,7 @@ def get_scenes_presentation_config(
     "--record-to",
     "record_to",
     metavar="FILE",
-    type=click.Path(dir_okay=False),
+    type=click.Path(dir_okay=False, path_type=Path),
     default=None,
     help="If set, the presentation will be recorded into a AVI video file with given name.",
 )
@@ -794,13 +793,13 @@ def get_scenes_presentation_config(
 @verbosity_option
 def present(
     scenes: List[str],
-    config_path: str,
+    config_path: Path,
-    folder: str,
+    folder: Path,
     start_paused: bool,
     fullscreen: bool,
     skip_all: bool,
     resolution: Tuple[int, int],
-    record_to: Optional[str],
+    record_to: Optional[Path],
     exit_after_last_slide: bool,
     hide_mouse: bool,
     aspect_ratio: str,
@@ -825,7 +824,7 @@ def present(
         for presentation_config in get_scenes_presentation_config(scenes, folder)
     ]
 
-    if os.path.exists(config_path):
+    if config_path.exists():
         try:
             config = Config.parse_file(config_path)
         except ValidationError as e:
@@ -835,7 +834,7 @@ def present(
         config = Config()
 
     if record_to is not None:
-        _, ext = os.path.splitext(record_to)
+        ext = record_to.suffix
         if ext.lower() != ".avi":
             raise click.UsageError(
                 "Recording only support '.avi' extension. For other video formats, please convert the resulting '.avi' file afterwards."

manim_slides/slide.py

@@ -3,6 +3,7 @@ import platform
 import shutil
 import subprocess
 from typing import Any, List, Optional
+from warnings import warn
 
 from tqdm import tqdm
 
@@ -27,7 +28,7 @@ def reverse_video_file(src: str, dst: str) -> None:
 
 class Slide(Scene):  # type:ignore
     """
-    Inherits from `manim.Scene` or `manimlib.Scene` and provide necessary tools for slides rendering.
+    Inherits from :class:`manim.scene.scene.Scene` or :class:`manimlib.scene.scene.Scene` and provide necessary tools for slides rendering.
     """
 
     def __init__(
@@ -90,8 +91,51 @@ class Slide(Scene):  # type:ignore
         super().play(*args, **kwargs)
         self.current_animation += 1
 
-    def pause(self) -> None:
+    def next_slide(self):
-        """Creates a new slide with previous animations."""
+        """
+        Creates a new slide with previous animations.
+
+        This usually means that the user will need to press some key before the
+        next slide is played. By default, this is the right arrow key.
+
+
+        .. note::
+
+            Calls to :func:`next_slide` at the very beginning or at the end are
+            not needed, since they are automatically added.
+
+        .. warning::
+
+            This is not allowed to call :func:`next_slide` inside a loop.
+
+        Examples
+        --------
+
+        The following contains 3 slides:
+
+        #. the first with nothing on it;
+        #. the second with "Hello World!" fading in;
+        #. and the last with the text fading out;
+
+        .. code-block:: python
+
+            from manim import *
+            from manim_slides import Slide
+
+            class Example(Slide):
+                def construct(self):
+                    text = Text("Hello World!")
+
+                    self.next_slide()
+                    self.play(FadeIn(text))
+
+                    self.next_slide()
+                    self.play(FadeOut(text))
+        """
+        assert (
+            self.loop_start_animation is None
+        ), "You cannot call `self.next_slide()` inside a loop"
+
         self.slides.append(
             SlideConfig(
                 type=SlideType.slide,
@@ -103,8 +147,30 @@ class Slide(Scene):  # type:ignore
         self.current_slide += 1
         self.pause_start_animation = self.current_animation
 
+    def pause(self) -> None:
+        """
+        Creates a new slide with previous animations.
+
+        .. deprecated:: 4.10.0
+            Use :func:`next_slide` instead.
+        """
+        warn(
+            "`self.pause()` is deprecated. Use `self.next_slide()` instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self.next_slide()
+
     def add_last_slide(self) -> None:
         """Adds a 'last' slide to the end of slides."""
+
+        if (
+            len(self.slides) > 0
+            and self.current_animation == self.slides[-1].end_animation
+        ):
+            self.slides[-1].type = SlideType.last
+            return
+
         self.slides.append(
             SlideConfig(
                 type=SlideType.last,
@@ -115,12 +181,37 @@ class Slide(Scene):  # type:ignore
         )
 
     def start_loop(self) -> None:
-        """Starts a loop."""
+        """
+        Starts a loop. End it with :func:`end_loop`.
+
+        A loop will automatically replay the slide, i.e., everything between
+        :func:`start_loop` and :func:`end_loop`, upon reaching end.
+
+        Examples
+        --------
+
+        The following contains one slide that will loop endlessly.
+
+        .. code-block:: python
+
+            from manim import *
+            from manim_slides import Slide
+
+            class Example(Slide):
+                def construct(self):
+                    dot = Dot(color=BLUE)
+
+                    self.start_loop()
+
+                    self.play(Indicate(dot))
+
+                    self.end_loop()
+        """
         assert self.loop_start_animation is None, "You cannot nest loops"
         self.loop_start_animation = self.current_animation
 
     def end_loop(self) -> None:
-        """Ends an existing loop."""
+        """Ends an existing loop. See :func:`start_loop` for more details."""
         assert (
             self.loop_start_animation is not None
         ), "You have to start a loop before ending it"
@@ -224,9 +315,9 @@ class Slide(Scene):  # type:ignore
 
 class ThreeDSlide(Slide, ThreeDScene):  # type: ignore
     """
-    Inherits from `manim.ThreeDScene` or `manimlib.ThreeDScene` and provide necessary tools for slides rendering.
+    Inherits from :class:`Slide` and :class:`manim.scene.three_d_scene.ThreeDScene` or :class:`manimlib.scene.three_d_scene.ThreeDScene` and provide necessary tools for slides rendering.
 
-    Note that ManimGL does not need ThreeDScene for 3D rendering in recent versions, see `example.py`.
+    .. note:: ManimGL does not need ThreeDScene for 3D rendering in recent versions, see `example.py`.
     """
 
     pass

manim_slides/wizard.py

@@ -21,7 +21,7 @@ from PySide6.QtWidgets import (
 from .commons import config_options, verbosity_option
 from .config import Config, Key
 from .defaults import CONFIG_PATH
-from .manim import logger
+from .logger import logger
 from .resources import *  # noqa: F401, F403
 
 WINDOW_NAME: str = "Configuration Wizard"
@@ -51,7 +51,6 @@ class KeyInput(QDialog):  # type: ignore
 
 class Wizard(QWidget):  # type: ignore
     def __init__(self, config: Config):
-
         super().__init__()
 
         self.setWindowTitle(WINDOW_NAME)

paper/paper.bib

@@ -0,0 +1,53 @@
+@online{manim-announcement,
+  author = {Grant Sanderson},
+  title = {{Q}\&{A} with {G}rant {S}anderson (3blue1brown)},
+  year = {2018},
+  organization = {YouTube},
+  url = {https://www.youtube.com/watch?v=Qe6o9j4IjTo\&ab_channel=3Blue1Brown}
+}
+
+@misc{revealjs,
+  author = {Hakim El Hattab},
+  title = {The HTML Presentation Framework},
+  year = {2022},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  url = {https://github.com/hakimel/reveal.js}
+}
+
+@misc{manim-presentation,
+  author = {Federico Galatolo},
+  title = {Tool for live presentations using manim},
+  year = {2021},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  url = {https://github.com/galatolofederico/manim-presentation}
+}
+
+@misc{manimgl,
+  author = {Grant Sanderson},
+  title = {Animation engine for explanatory math videos},
+  year = {2022},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  url = {https://github.com/3b1b/manim}
+}
+
+@misc{manim-editor,
+  author = {Christopher Besch},
+  title = {Web Presenter for Mathematical Animations using Manim},
+  year = {2022},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  url = {https://github.com/ManimCommunity/manim_editor}
+}
+
+@software{manimce,
+  author = {{The Manim Community Developers}},
+  license = {MIT},
+  month = {12},
+  title = {{Manim – Mathematical Animation Framework}},
+  url = {https://www.manim.community/},
+  version = {v0.17.2},
+  year = {2022}
+}

paper/paper.md

@@ -0,0 +1,125 @@
+---
+title: 'Manim Slides: A Python package for presenting Manim content anywhere'
+tags:
+  - Python
+  - manim
+  - animations
+  - teaching
+  - conference presentations
+  - tool
+authors:
+  - name: Jérome Eertmans
+    orcid: 0000-0002-5579-5360
+    affiliation: 1
+affiliations:
+ - name: ICTEAM, UCLouvain, Belgium
+   index: 1
+date: 2 March 2023
+bibliography: paper.bib
+---
+
+# Summary
+
+Manim Slides is a Python package that makes presenting Manim animations
+straightforward. With minimal changes required to pre-existing code, one can
+slide through animations in a *PowerPoint-like* manner, or share its slides
+*online* using ReavealJS' power.
+
+# Introduction
+
+Presenting educational content has always been a difficult task, especially
+when it uses temporal or iterative concepts. During the last decades, the
+presence of computers in classrooms for educational purposes has increased
+enormously, allowing teachers to show animated or interactive content.
+
+With the democratization of YouTube, many people have decided to use this
+platform to share educational content. Among these people, Grant Sanderson, a
+YouTuber presenting videos on the theme of mathematics, quickly became known
+for his original and quality animations. In 2018, Grant announced in a video
+that he creates his animations using a self-developed Python tool called Manim
+[@manim-announcement]. In 2019, he made the Manim source code public [@manimgl],
+so anyone can use his tool. Very quickly, the community came together and, in
+2020, created a "fork" of the original GitHub repository [@manimce], in order to
+create a more accessible and better documented version of this tool. Since then,
+the two versions are differentiated by using ManimGL for Grant Sanderson's
+version, as it uses OpenGL for rendering, and ManimCE for the community edition
+(CE).
+
+Despite the many advantages of the Manim tool in terms of illustrating
+mathematical concepts, one cannot help but notice that most presentations,
+whether in the classroom or at a conference, are mainly done with PowerPoint
+or PDF slides. One of the many advantages of these formats, as opposed to videos
+created with Manim, is the ability to pause, rewind, etc., whenever you want.
+
+To face this problem, in 2021, the manim-presentation tool was created
+[@manim-presentation]. This tool allows you to present Manim animations as you
+would present slides: with pauses, slide jumps, etc. However, this tool has
+evolved very little since its inception and does not work with ManimGL.
+
+In 2022, Manim Slides has been created from manim-presentation, with the aim
+to make it a more complete tool, better documented, and usable on all platforms
+and with ManimCE or ManimGL. After almost a year of existence, Manim Slides has
+evolved a lot, has built a small community of contributors, and continues to
+provide new features on a regular basis.
+
+# Easy to Use Commitment
+
+Manim Slides is commited to be an easy-to-use tool, when minimal installation
+procedure and few modifications required. It can either be used locally with its
+graphical user interface (GUI), or shared via HTML thanks to the RevealJS
+Javascript package [@revealjs].
+
+This work has a very similar syntax to Manim and offers a comprehensive
+documentation hosted on [GitHub pages](https://eertmans.be/manim-slides/), see
+\autoref{fig:docs}.
+
+![Manim Slides' documentation homepage.\label{fig:docs}](docs.png)
+
+# Example usage
+
+We have used manim-presentation for our presentation at the COST
+Interact, hosted in Lyon, 2022, and
+[available online](https://eertmans.be/research/cost-interact-presentation/).
+This experience highly motivated the development of Manim Slides, and our
+EuCAP 2023 presentation slides are already
+[available online](https://eertmans.be/research/eucap-presentation/), thanks
+to Manim Slides' HTML feature.
+
+Also, one of our users created a short
+[video tutorial](https://www.youtube.com/watch?v=Oc9g89VzKsY&ab_channel=TheoremofBeethoven)
+and posted it on YouTube.
+
+# Stability and releases
+
+Manim Slides is continously tested on most recent Python versions, both ManimCE
+and ManimGL, and on all major platforms: **Ubuntu**, **macOS** and **Windows**. As of Manim
+Slide's exposed API begin very minimal, and the variaty of tests that are
+performed, this tool can be considered stable over time.
+
+New releases are very frequent, as they mostly introduce enhancements or small
+documention fixes, and the command-line tool automatically notifies for new
+available updates. Therefore, regularly updating Manim Slides is highly
+recommended.
+
+# Statement of Need
+
+Similar tools to Manim Slides also exist, such as its predecessor,
+manim-presentation [@manim-presentation], or the web-based alternative, Manim
+Editor [@manim-editor], but none of them provide the documentation level nor the
+amount of features that Manim Slides strives to. This work makes the task of
+presenting Manim content in front of an audience much easier than before,
+allowing presenters to focus more on the content of their slides, rather than on
+how to actually present them efficiently.
+
+# Acknowledgements
+
+We acknowledge the work of [@manim-presentation] that paved the initial structure
+of Manim Slides with the manim-presentation Python package.
+
+We also acknowledge Grant Sanderson for its termendous work on Manim, as well as
+well as the Manim Community contributors.
+
+Finally, we also acknowledge contributions from the GitHub contributors on the
+Manim Slides repository.
+
+# References

pyproject.toml

@@ -1,104 +1,110 @@
-[tool.poetry]
-name = "manim-slides"
-description = "Tool for live presentations using manim"
-authors = [
-    "Jérome Eertmans <jeertmans@icloud.com>"
-]
-version = "4.8.1"
-license = "GPL-3.0-only"
-readme = "README.md"
-homepage = "https://github.com/jeertmans/manim-slides"
-documentation = "https://eertmans.be/manim-slides"
-repository = "https://github.com/jeertmans/manim-slides"
-
-keywords = ["manim", "slides", "plugin", "manimgl"]
-
-classifiers = [
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-        "Operating System :: OS Independent",
-        "Topic :: Multimedia :: Video",
-        "Topic :: Multimedia :: Graphics",
-        "Topic :: Scientific/Engineering",
-    ]
-
-exclude = ["docs/","static/"]
-packages = [
-    { include = "manim_slides" },
-]
-
-
-[tool.poetry.dependencies]
-python = ">=3.8.1,<3.12"
-click = "^8.1.3"
-click-default-group = "^1.2.2"
-numpy = "^1.19"
-opencv-python = "^4.6.0.66"
-pydantic = "^1.10.2"
-pyside6 = "^6.4.1"
-requests = "^2.28.1"
-tqdm = "^4.64.1"
-
-[tool.poetry.group.docs.dependencies]
-manim = "^0.17.0"
-sphinx = "^5.3.0"
-sphinx-click = "^4.4.0"
-furo = "^2022.9.29"
-
-[tool.poetry.group.dev.dependencies]
-black = "^22.10.0"
-mypy = "^0.991"
-isort = "^5.10.1"
-flake8 = "^6.0.0"
-
-[tool.poetry.group.test.dependencies]
-manim = "^0.17.0"
-manimgl = "^1.6.1"
-
 [build-system]
-requires = ["setuptools","poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+requires = ["setuptools", "poetry-core>=1.0.0"]
+
+[tool.black]
+target-version = ["py38"]
 
 [tool.isort]
 profile = "black"
 py_version = 38
 
-[tool.black]
-target-version = ["py38"]
-
 [tool.mypy]
-python_version = "3.8"
+check-untyped-defs = true
-install-types = true
-non-interactive = true
-ignore-missing-imports = true
 # Disallow dynamic typing
 disallow-any-generics = true
+disallow-incomplete-defs = true
 disallow-subclassing-any = true
-
 # Disallow untyped definitions and calls
 disallow-untyped-defs = true
-disallow-incomplete-defs = true
+ignore-missing-imports = true
-check-untyped-defs = true
+install-types = true
-
 # None and optional handling
 no-implicit-optional = true
-
-# Configuring warnings
-warn-unused-ignores = true
-warn-no-return = true
 no-warn-return-any = true
-warn-redundant-casts = true
+non-interactive = true
-
+python_version = "3.8"
 # Strict equality
 strict-equality = true
-
+warn-no-return = true
+warn-redundant-casts = true
 # Config file
 warn-unused-configs = true
+# Configuring warnings
+warn-unused-ignores = true
+
+[tool.poetry]
+authors = [
+  "Jérome Eertmans <jeertmans@icloud.com>"
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Topic :: Multimedia :: Video",
+  "Topic :: Multimedia :: Graphics",
+  "Topic :: Scientific/Engineering"
+]
+description = "Tool for live presentations using manim"
+documentation = "https://eertmans.be/manim-slides"
+exclude = ["docs/", "static/"]
+homepage = "https://github.com/jeertmans/manim-slides"
+keywords = ["manim", "slides", "plugin", "manimgl"]
+license = "MIT"
+name = "manim-slides"
+packages = [
+  {include = "manim_slides"}
+]
+readme = "README.md"
+repository = "https://github.com/jeertmans/manim-slides"
+version = "4.10.0"
+
+[tool.poetry.dependencies]
+click = "^8.1.3"
+click-default-group = "^1.2.2"
+lxml = "^4.9.2"
+numpy = "^1.19"
+opencv-python = "^4.6.0.66"
+pydantic = "^1.10.2"
+pyside6 = "^6.4.1"
+python = ">=3.8.1,<3.12"
+python-pptx = "^0.6.21"
+requests = "^2.28.1"
+rich = "^13.3.2"
+tqdm = "^4.64.1"
+
+[tool.poetry.group.dev.dependencies]
+black = "^22.10.0"
+bump2version = "^1.0.1"
+isort = "^5.12.0"
+mypy = "^0.991"
+pre-commit = "^3.0.2"
+ruff = "^0.0.219"
+
+[tool.poetry.group.docs.dependencies]
+furo = "^2022.9.29"
+manim = "^0.17.0"
+myst-parser = "^0.18.1"
+sphinx = "^5.3.0"
+sphinx-click = "^4.4.0"
+sphinx-copybutton = "^0.5.1"
+sphinxext-opengraph = "^0.7.5"
+
+[tool.poetry.group.test.dependencies]
+manim = "^0.17.0"
+manimgl = "^1.6.1"
 
 [tool.poetry.plugins]
+
 [tool.poetry.plugins."console_scripts"]
 manim-slides = "manim_slides.__main__:cli"
+
+[tool.ruff]
+ignore = [
+  "E501"
+]
+target-version = "py38"

static/logo.py

@@ -1,17 +1,29 @@
 # flake8: noqa: F403, F405
 # type: ignore
+import os
+
 from manim import *
 
+THEME = os.environ.get("MANIM_SLIDES_THEME", "light").lower().replace("_", "-")
+
 
 class ManimSlidesLogo(Scene):
     def construct(self):
         tex_template = TexTemplate()
         tex_template.add_to_preamble(r"\usepackage{graphicx}\usepackage{fontawesome5}")
-        self.camera.background_color = "#ffffff"
+        self.camera.background_color = {
+            "light": "#ffffff",
+            "dark-docs": "#131416",
+            "dark-github": "#0d1117",
+        }[THEME]
         logo_green = "#87c2a5"
         logo_blue = "#525893"
         logo_red = "#e07a5f"
-        logo_black = "#343434"
+        logo_black = {
+            "light": "#343434",
+            "dark-docs": "#d0d0d0",
+            "dark-github": "#c9d1d9",
+        }[THEME]
         ds_m = MathTex(r"\mathbb{M}", fill_color=logo_black).scale(7)
         ds_m.shift(2.25 * LEFT + 1.5 * UP)
         slides = MathTex(r"\mathbb{S}\text{lides}", fill_color=logo_black).scale(4)

static/make_logo.sh

@@ -0,0 +1,21 @@
+#! /bin/bash
+
+MANIM_SLIDES_THEME=light poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo.png
+
+ln -f -r -s static/logo.png docs/source/_static/logo.png
+
+MANIM_SLIDES_THEME=dark_docs poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_docs.png
+
+ln -f -r -s static/logo_dark_docs.png docs/source/_static/logo_dark_docs.png
+
+MANIM_SLIDES_THEME=dark_github poetry run manim render -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_github.png
+
+ln -f -r -s static/logo_dark_github.png docs/source/_static/logo_dark_github.png
+
+MANIM_SLIDES_THEME=light poetry run manim render -t -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_light_transparent.png
+
+ln -f -r -s static/logo_light_transparent.png docs/source/_static/logo_light_transparent.png
+
+MANIM_SLIDES_THEME=dark_docs poetry run manim render -t -qk -s --format png --resolution 2560,1280 static/logo.py && mv media/images/logo/*.png static/logo_dark_transparent.png
+
+ln -f -r -s static/logo_dark_transparent.png docs/source/_static/logo_dark_transparent.png