manim/pyproject.toml
Anton Ballmaier 71b86d5dfa
Deprecation Decorators (#1404)
* test

* revert test changes

* finish draft implementation

* use @wrapss to remove docs problems

* reduce complexity and add doc deprecation

* Docs deprecated_params

* add decoratos to __init__

* Add decorators to documentation

* Finish detailed docs

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

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

* Apply suggestions from code review

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* change since/until/message param docs

* Mark get_callable_info and deprecation_text_component as private

* change how until is included in warning messages

* Add The to prameter descriptions

* is deprecated => has been deprecated

* Fix typo

* fix typo

* make params docs more readable

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

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

* make redirections docs clearer

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

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

* Fix typo

* fix typo

* fix typo

* is_are => has_have_been

* fix typo
(at this point I am questioning my ability to type prameter)

* update deprendency list

* order dependencies

* update examples

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

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

* fix dependeny problem

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

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

* fix duplicate problem

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

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

* change decorator version

* updated lock file

* enhance function / method separation

* fix typo and double underscores

* rename message_ and replacement_

* Change warning to custom admonition

* remove [] as default parameters

* Remove "" around type

* fix typo

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

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

* fix bug and move to inspect

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

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

* doc string => docstring

* rename to deprecate

* change module docstring

* change to deprecation.py

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

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

* some sugesstions

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

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

* remove tests again

* Rename decorators.py to deprecate.py

* Update poetry.lock

* Test if deprecated class outputs the correct warning when used

* Rename deprecate to deprecation

* Fix typos

* Shorten conditional for msg

* Shorten conditional for since

* Shorten conditional for until

* Specify decorator arguments in test

* Add tests for since and until arguments

* Add test for since and until as arguments

* Add test for msg argument for class

* Add test for replacement argument for class

* Remove unneeded docstring in deprecated class

* Add test for deprecate method, no args

* Update docstring examples, move deprecated method outside class

* Add test for method in class, since and message args

* Add test for deprecating nested class

* Add test for deprecated method in nested class

* Test deprecation of nested function

* Test param deprecation, only params argument

* Test deprecation of single method param

* Rename single param test method name

* Fix deprecated_params docstring whitespace

* Test parameter redirection using tuple

* Update warning msgs in deprecated_params docstring

* Test parameter redirection using lambda function

* Test param redirection from many to one

* Test param redirection from one to many

* Update Top.foo to deprecate with message

* handle empty docstrings

* fix typo

* Update poetry.lock

* Update poetry.lock

* Deprecate ShowCreation using decorator to test the docs

* Test docstring for deprecated class

* Test docstring for Bar and Baz classes

* Test docstrings for the rest of the classes

* Test docstrings for Top methods

* Test docstrings for Top.Nested

* Test docstring for nested method

* Move deprecations to deprecation system

* Some more deprecations

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

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

* fix version numbering inconsistancies

* Fix naming issue and MetaClass handling

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

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

* restart CI

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Ricky Chon <rickychon99@gmail.com>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-11 08:31:55 +02:00

113 lines
2.9 KiB
TOML

[tool.poetry]
name = "manim"
version = "0.6.0"
description = "Animation engine for explanatory math videos."
authors = ["The Manim Community Developers","3b1b <grant@3blue1brown.com>"]
license="MIT"
readme="README.md"
repository="https://github.com/manimcommunity/manim"
documentation="https://docs.manim.community/"
homepage="https://www.manim.community/"
classifiers= [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: MIT License",
"Topic :: Scientific/Engineering",
"Topic :: Multimedia :: Video",
"Topic :: Multimedia :: Graphics",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Natural Language :: English",
]
exclude = ["scripts/","logo/","readme-assets/"]
packages = [
{ include = "manim" },
]
[tool.poetry.dependencies]
python = "^3.7"
click = "^7.1"
click-default-group = "*"
colour = "*"
numpy = "^1.9"
Pillow = "*"
scipy = "*"
tqdm = "*"
pydub = "*"
pygments = "*"
rich = "^6.0"
pycairo = "^1.19"
manimpango = "^0.2.4"
networkx = "^2.5"
decorator = "^5.0.7"
setuptools = "*"
importlib-metadata = {version = "*", python = "<3.8"}
grpcio = { version = "1.33.*", optional = true }
grpcio-tools = { version = "1.33.*", optional = true }
watchdog = "*"
jupyterlab = { version = "^3.0", optional = true }
moderngl = "^5.6.3"
moderngl-window = "^2.3.0"
mapbox-earcut = "^0.12.10"
cloup = "^0.7.0"
requests = "*"
[tool.poetry.extras]
webgl_renderer = ["grpcio","grpcio-tools"]
jupyterlab = ["jupyterlab"]
[tool.poetry.dev-dependencies]
pytest-cov = "*"
pytest = "^6.0"
pylint = "*"
Sphinx = "^3"
sphinx-copybutton = "*"
sphinxext-opengraph = "*"
furo = "*"
recommonmark = "*"
matplotlib = "^3.3.2"
pre-commit = "^2.11.1"
gitpython = "^3"
pygithub = "^1"
flake8 = "^3.9.0"
isort = "^5.8.0"
[tool.poetry.urls]
"Bug Tracker" = "https://github.com/ManimCommunity/manim/issues"
"Changelog" = "https://docs.manim.community/en/stable/changelog.html"
"Twitter" = "https://twitter.com/manim_community"
"Discord" = "https://discord.gg/mMRrZQW"
[tool.poetry.dev-dependencies.black]
version = "^20.8b1"
allow-prereleases = false
python = "^3.6"
markers = "platform_python_implementation == 'CPython'"
[tool.pytest.ini_options]
markers = "slow: Mark the test as slow. Can be skipped with --skip_slow"
addopts = "--cov=manim --cov-report xml --cov-report term"
[tool.isort]
# from https://black.readthedocs.io/en/stable/compatible_configs.html
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
ensure_newline_before_comments = true
line_length = 88
[tool.coverage.run]
omit = ["*tests*"]
[tool.coverage.report]
exclude_lines = ["pragma: no cover"]
[tool.poetry.plugins]
[tool.poetry.plugins."console_scripts"]
"manim" = "manim.__main__:main"
"manimce" = "manim.__main__:main"
[build-system]
requires = ["setuptools","poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"