v0.1.0 Roadmap

[leotrs]

There seems to be enough activity on this repo to try and move forward with a release version of the community version of manim. For this, let's use this issue to keep track of what needs to be done and when. Logistically, this should be the last issue to be closed in the v1.0.0 milestone, and once this one is closed, we should be able to push to pypi.

Things that need to be discussed

1. I think there is a sense among @ManimCommunity/core devs that v1.0.0 should be fully backwards compatible. This has not been fully discussed, however.
2. For full backwards compatibility, we need to determmine a timeline for deprecation.
3. It has been decided that this repo will have both manim and manimcm as entrypoints. Some of us have started calling it manim CE (for Community Edition). Personally, I like "manim CE" as a name (and the accompanying manimce entrypoint) more than "manimcm". Though I don't ultimately care either way...
4. I think it would be nice to have a logo at the time of release Logo #106

Things that need to be implemented

Get rid of CONFIG dicts in each class and migrate to dataclasses #7

• Add extensive tests Add tests with pytest #133
• Add documentation Documentation guidelines #103 Documentation host or domain #38 Bring Docs Branch up-to-date with Master #104 with sphinix on ReadTheDocs Documentation host or domain #38, including a quickstart Create a Quickstart guide #120
• Migrate configuration to configparser and cascading .cfg files Configparser setup: figuring out config.py, constants.py, dirs.py, CLI arguments, and more [WIP] #98.
• Clean up constants.py Configparser setup: figuring out config.py, constants.py, dirs.py, CLI arguments, and more [WIP] #98.
• Make a logo Logo #106
• There are a bunch of things that depend on CONFIG dictionaries stuff  #7, Configparser setup: figuring out config.py, constants.py, dirs.py, CLI arguments, and more [WIP] #98, and Add tests with pytest #133, so we have to determine whether each one of those are required for a v1.0.0.
• Add a Scene Cacher Added Scene caching #166
• Additional documentation examples Bunch of more examples for the docs #458
• Various small improvements FIX : 472 / Small refactor of partial-movie-files handling  #489, docs: add manim latex chocolatey package #490, Make Text and Tex robust against non-existing text_dir and tex_dir #492, Follow Up PR from Color enums #496, FIX : fixed tuples in hashing, by converting them to lists #498
• Automate publishing to pypi ci: fix publishing to pip #500
• Update the README image containing an example command Deprecated CLI flag is advertised on our github front page #572

Please feel free to edit this issue to add/remove/check off things as you see fit.

After the release

• make PangoText the default backend of Text (Changing fonts in "Text" does not work #487)
• invite developers of other manim-related projects to become part of the organization (or at least ask them to support manim CE). For example: https://github.com/krassowski/jupyter-manim

[yoshiask]

To be clear, new features like the improved SVG parser and more GraphScene configuration are not slated for the 1.0.0 release?

[leotrs]

Yeah this is exactly what we should discuss here. My personal opinion is that v1.0.0 should be fully backwards compatible, as well as documented and tested, and some of the major problems with the code should be addressed. If that's the case, then a v1.0.0 could be ready in perhaps a couple of months. We could then leave new features for v1.1 release.

Now, if there are new features ready for a v1.0.0 I guess there's no hurt in adding them as long as they are fully backwards compatible. But the intent of this versioning is that most focus should be put into finishing v1.0.0 (i.e. in testing and documenting) before spending our efforts in new features.

Happy to hear different opinions here.

[yoshiask]

#7 and #98 are must-haves for this new version. Is #98 backwards compatible?

[leotrs]

Argh, good question. It does support all the same flags (and fixes some of them too), but many variables from constants.py are removed. So no, it's not compatible.

[PgBiel]

by thursday I should open the draft PR on attrs, typings and docs

[huguesdevimeux]

@leotrs Could you update this with you work on #98 ?

[leotrs]

Just updated the check list at the top. Please refer to it for what to do next.

[leotrs]

Update: the main thing between us and a release version of ManimCE is the attrs branch. A logo would be nice-to-have but not strictly necessary I think.

[leotrs]

As far as I can tell from yesterday's Discord call, we will try to have the following ready for a 1.0 release:

1. documentation up on RTD (Read The Docs setup #381 )
2. pypi package (Package Name On PyPI #202 Package Name On PyPI #202 )
3. logo
4. set up poetry Move to Poetry #165

[naveen521kk]

@leotrs We are using poetry for releasing and stuff. So do add it in list also.

[leotrs]

Good call

[huguesdevimeux]

(There is a milestone for the release, let's use it ;) )

[naveen521kk]

Another thing is we need to change manimlib to manim in pyproject.toml #165
Fixed in #534

[leotrs]

Folks, it seems we have completed every item on the list except for the logo, which should be decided upon by Tuesday Oct 20th noon GMT. I suggest we add the logo and also fix #407 and then release this bad boi. Objections? Comments? @ManimCommunity/core

If there are no objections, I move we put a freeze on PRs right now.