Add --version commandline flag

[WampyCakes]

Motivation

Aids helping Manim errors by providing version command. Will be needed for the Manim Showcase as well (#934). This command should be added before the next release as --version should be available in all Manim versions, but won't be because it is too late.

Overview / Explanation for Changes

Reads the version from metadata from pyproject.toml (explained here). Adds a --version command to print the version. Adds it to --help and the list of CLI flags in the documentation. Added a test to confirm the command continues to provide the correct version.

Oneline Summary of Changes

- Added a --version CLI flag (:pr:`PR NUMBER HERE`)

Additional Comments

In the future, commit hashes or some other such thing should be included as well (#541)

Acknowledgements

• I have read the Contributing Guidelines

Reviewer Checklist

• Newly added functions/classes are either private or have a docstring
• Newly added functions/classes have tests added and (optional) examples in the docs
• Newly added documentation builds, looks correctly formatted, and adds no additional build warnings
• The oneline summary has been included in the wiki

[leotrs]

Great! Can you please take care of the tests?

[behackl]

Code looks good to me, have not tried it locally yet. I just have one minor suggestion.

Thanks for picking is up, adding a version command was overdue. :-)

[WampyCakes]

Can you please take care of the tests?

@leotrs How can I fix the dependency errors in the checks?

[behackl]

Can you please take care of the tests?

@leotrs How can I fix the dependency errors in the checks?

You'll need to run poetry lock, I think.

[jsonvillanueva]

Can you please take care of the tests?

@leotrs How can I fix the dependency errors in the checks?

You'll need to run poetry lock, I think.

I believe you need to run poetry update as the error logs are saying:
Warning: The lock file is not up to date with the latest changes in pyproject.toml. You may be getting outdated dependencies. Run update to update them.

[behackl]

Hmm, this is weird:

(manim-jRHFv4qq-py3.7) behackl@home:~/code/manim$ manim --version
Manim Community Edition v0.1.1

I am running this from the current version of this branch, the version should be v0.2.0. Any idea what is happening here?

[WampyCakes]

@behackl No, that's rather odd. It shows 0.2.0 for me.

[jsonvillanueva]

Hmm, this is weird:

(manim-jRHFv4qq-py3.7) behackl@home:~/code/manim$ manim --version
Manim Community Edition v0.1.1

I am running this from the current version of this branch, the version should be v0.2.0. Any idea what is happening here?

(manim) C:\Users\a\Documents\repos\ManimCommunity\manim\example_scenes>manim --version
Manim Community Edition v0.2.0

Works fine for me. You might have multiple conflicting installs?

[behackl]

$ python
Python 3.7.5 (default, Nov  7 2019, 10:50:52) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import manim
>>> manim.__version__
'0.1.1'

This is within the virtual environment provided by poetry, there are no other installations of manim present in there.

[jsonvillanueva]

$ python
Python 3.7.5 (default, Nov  7 2019, 10:50:52) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import manim
>>> manim.__version__
'0.1.1'

This is within the virtual environment provided by poetry, there are no other installations of manim present in there.

I feel like this has to do with you using poetry lock earlier, but I'm unsure. We can continue debugging on discord since that's quicker, but this looks good to me atm.

[WampyCakes]

Update for records sake: The issue described above was a local issue. The command works. Added a test_version pytest, all checks passed. Good to merge?