manta-manim-theme


Namemanta-manim-theme JSON
Version 0.8.0 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-10-31 17:47:11
maintainerNone
docs_urlNone
authorAlexander Nasuta
requires_python<3.13,>=3.11
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img src="https://raw.githubusercontent.com/Alexander-Nasuta/manta/main/resources/logos/logo.png" alt="Alt text" style="max-height: 200px;">
</p>

# Manta

A Framework for building Presentation Slides and themed Videos with Manim. 

- Github: [Manta](https://github.com/Alexander-Nasuta/manta)
- Pypi: [Manta](https://pypi.org/project/manta-manim-theme/)
- Documentation: [Manta Docs](https://alexander-nasuta.github.io/manta/)

## Description

Manta originated from the idea of creating presentation slides with Manim in an easy and time-efficient way.
PowerPoints has extensions and libraries such as [Efficient Elements](https://www.efficient-elements.com/de/) to get 
done presentations faster and more efficiently. Manta essentially tries to do the same for Manim.

Manta is a framework that provides a set of useful tools to create presentation slides with Manim.
It features the following components:
- **SlideTemplates**: Manta provides a set of predefined slide templates that can be used to create slides.
- **Theming**: Manta provides a set of predefined themes and the possibility to create custom themes. Predefined themes
  include [Catppuccin](https://github.com/catppuccin/catppuccin) and [Tokyo Night](https://github.com/folke/tokyonight.nvim).
- **Icons**: Manta provides a waste set of icons that can be used in the slides that you might know from using Nerdfonts.  
- **Editor**: Manim-Editor is a GUI for creating slides with Manim. Mantas slides are designed to be used with Manim-Editor.
- **Examples**: Manta provides a set of examples to get started with creating slides.


## Table of Contents

- [Quickstart](#quickstart)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [State of the Project](#state-of-the-project)
- [Roadmap](#roadmap)
- [Contact](#contact)


## Quickstart

For the default Manta Theme, the following Nerd Fonts are required to be installed on your system:
- [IosevkaTermSlab](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/IosevkaTermSlab.zip)
- [Symbols Nerd Font](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/NerdFontsSymbolsOnly.zip)

You can find the installation instructions for the Nerd Fonts [here](https://www.nerdfonts.com/)

First install manta via pip:
```shell
pip install manta-manim-theme
```
Then update manim to the latest version:
```shell
pip install -U manim
```
you might see the following error:

```
ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
manim-editor 0.3.8 requires manim<0.14.0,>=0.13.1, but you have manim 0.18.1 which is incompatible.
```

Manta uses [Manim-Editor](https://docs.editor.manim.community/en/stable/) for creating slides.
Unfortunately the Manim-Editor dependency is a bit dated and states that it is only compatible with Manim version up to
0.13.1. However, Manta is actually required to use a more recent version of Manim (the initial manta package was developed with the manim version 0.18.1).


## Documentation

The documentation for Manta can be found [here](https://alexander-nasuta.github.io/manta/).

Here are also other resources that might be helpful:
- [Manim Documentation](https://docs.manim.community/en/stable/)
- [Manim-Editor Documentation](https://docs.editor.manim.community/en/stable/)
- [Manim-Community Discord](https://discord.gg/mMRrZQg)

## Contributing

If you want to contribute to Manta, you can do so by creating a pull request. 
If you add new features, please make sure to add minimal test and a example for them in the docs.
Currently there is no automated testing for Manta, I am also unsure if there is a feasible way to test the output of the slides.

## State of the Project

I am using Manta myself to create slides for my presentations, that need to be especially fancy. This will not change in the near future. 
I assume that I will continue to develop Manta and add new features to it till at least the end of 2027.

## Roadmap
- [ ] Add automated testing with tox and pytest
- [ ] Fix Manim-Editor version compatibility

## Contact

If you have any questions or feedback, feel free to contact me via [email](mailto:alexander.nasuta@wzl-iqs.rwth-aachen.de)

## Dev

# build
`poetry build`
# upload on PyPi
`twine check dist/**`
`twine upload dist/**`

# docs
`sphinx-autobuild docs/source/ docs/build/html/`

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "manta-manim-theme",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Alexander Nasuta",
    "author_email": "alexander.nasuta@ima.rwth-aachen.de",
    "download_url": "https://files.pythonhosted.org/packages/22/4b/802e2be65abd2f1817939e26f42b8d970789248c51f0e28206dda0e9b6d2/manta_manim_theme-0.8.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/Alexander-Nasuta/manta/main/resources/logos/logo.png\" alt=\"Alt text\" style=\"max-height: 200px;\">\n</p>\n\n# Manta\n\nA Framework for building Presentation Slides and themed Videos with Manim. \n\n- Github: [Manta](https://github.com/Alexander-Nasuta/manta)\n- Pypi: [Manta](https://pypi.org/project/manta-manim-theme/)\n- Documentation: [Manta Docs](https://alexander-nasuta.github.io/manta/)\n\n## Description\n\nManta originated from the idea of creating presentation slides with Manim in an easy and time-efficient way.\nPowerPoints has extensions and libraries such as [Efficient Elements](https://www.efficient-elements.com/de/) to get \ndone presentations faster and more efficiently. Manta essentially tries to do the same for Manim.\n\nManta is a framework that provides a set of useful tools to create presentation slides with Manim.\nIt features the following components:\n- **SlideTemplates**: Manta provides a set of predefined slide templates that can be used to create slides.\n- **Theming**: Manta provides a set of predefined themes and the possibility to create custom themes. Predefined themes\n  include [Catppuccin](https://github.com/catppuccin/catppuccin) and [Tokyo Night](https://github.com/folke/tokyonight.nvim).\n- **Icons**: Manta provides a waste set of icons that can be used in the slides that you might know from using Nerdfonts.  \n- **Editor**: Manim-Editor is a GUI for creating slides with Manim. Mantas slides are designed to be used with Manim-Editor.\n- **Examples**: Manta provides a set of examples to get started with creating slides.\n\n\n## Table of Contents\n\n- [Quickstart](#quickstart)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [State of the Project](#state-of-the-project)\n- [Roadmap](#roadmap)\n- [Contact](#contact)\n\n\n## Quickstart\n\nFor the default Manta Theme, the following Nerd Fonts are required to be installed on your system:\n- [IosevkaTermSlab](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/IosevkaTermSlab.zip)\n- [Symbols Nerd Font](https://github.com/ryanoasis/nerd-fonts/releases/download/v3.2.1/NerdFontsSymbolsOnly.zip)\n\nYou can find the installation instructions for the Nerd Fonts [here](https://www.nerdfonts.com/)\n\nFirst install manta via pip:\n```shell\npip install manta-manim-theme\n```\nThen update manim to the latest version:\n```shell\npip install -U manim\n```\nyou might see the following error:\n\n```\nERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.\nmanim-editor 0.3.8 requires manim<0.14.0,>=0.13.1, but you have manim 0.18.1 which is incompatible.\n```\n\nManta uses [Manim-Editor](https://docs.editor.manim.community/en/stable/) for creating slides.\nUnfortunately the Manim-Editor dependency is a bit dated and states that it is only compatible with Manim version up to\n0.13.1. However, Manta is actually required to use a more recent version of Manim (the initial manta package was developed with the manim version 0.18.1).\n\n\n## Documentation\n\nThe documentation for Manta can be found [here](https://alexander-nasuta.github.io/manta/).\n\nHere are also other resources that might be helpful:\n- [Manim Documentation](https://docs.manim.community/en/stable/)\n- [Manim-Editor Documentation](https://docs.editor.manim.community/en/stable/)\n- [Manim-Community Discord](https://discord.gg/mMRrZQg)\n\n## Contributing\n\nIf you want to contribute to Manta, you can do so by creating a pull request. \nIf you add new features, please make sure to add minimal test and a example for them in the docs.\nCurrently there is no automated testing for Manta, I am also unsure if there is a feasible way to test the output of the slides.\n\n## State of the Project\n\nI am using Manta myself to create slides for my presentations, that need to be especially fancy. This will not change in the near future. \nI assume that I will continue to develop Manta and add new features to it till at least the end of 2027.\n\n## Roadmap\n- [ ] Add automated testing with tox and pytest\n- [ ] Fix Manim-Editor version compatibility\n\n## Contact\n\nIf you have any questions or feedback, feel free to contact me via [email](mailto:alexander.nasuta@wzl-iqs.rwth-aachen.de)\n\n## Dev\n\n# build\n`poetry build`\n# upload on PyPi\n`twine check dist/**`\n`twine upload dist/**`\n\n# docs\n`sphinx-autobuild docs/source/ docs/build/html/`\n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.8.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba88246ac00c6abf500a9dcc8b7d16678c3a23a06531a93f1882cfc7390f03bf",
                "md5": "a80eb306899588707846073fa57fb28b",
                "sha256": "72df02af71f7453f69af5cfc8ad069271f6c477a590fcb57a2020c5221fd36a4"
            },
            "downloads": -1,
            "filename": "manta_manim_theme-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a80eb306899588707846073fa57fb28b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.11",
            "size": 14823243,
            "upload_time": "2024-10-31T17:41:55",
            "upload_time_iso_8601": "2024-10-31T17:41:55.478751Z",
            "url": "https://files.pythonhosted.org/packages/ba/88/246ac00c6abf500a9dcc8b7d16678c3a23a06531a93f1882cfc7390f03bf/manta_manim_theme-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "224b802e2be65abd2f1817939e26f42b8d970789248c51f0e28206dda0e9b6d2",
                "md5": "34c8b4d690c5dce8b706aba3ac913b3c",
                "sha256": "b629949e544fe3b20aef984f7f4a0f89b84632484cdcc52286fd3f1ed10055b6"
            },
            "downloads": -1,
            "filename": "manta_manim_theme-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "34c8b4d690c5dce8b706aba3ac913b3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.11",
            "size": 20180062,
            "upload_time": "2024-10-31T17:47:11",
            "upload_time_iso_8601": "2024-10-31T17:47:11.487218Z",
            "url": "https://files.pythonhosted.org/packages/22/4b/802e2be65abd2f1817939e26f42b8d970789248c51f0e28206dda0e9b6d2/manta_manim_theme-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-31 17:47:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "manta-manim-theme"
}
        
Elapsed time: 0.39584s