Unneccesary inclusion of mkdocs-material

[lofidevops]

setup.py includes the mkdocs-material theme as a requirement. This means that I have to install the theme (and its dependencies) even if I don't use it. Could this be made an optional dependency? If so I'm happy to work on making the change.

setup.py

    install_requires=[
        'setuptools>=18.5',
        'beautifulsoup4>=4.6.3',
        'mkdocs>=1.0.4',
        'jsbeautifier',
        'pyyaml', # for testing
        'mkdocs-material', # for testing
        'requests',
        'pymdown-extensions >= 8.0'
    ],

Relevant documentation

• https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies
• https://github.com/fralau/mkdocs_macros_plugin/blob/master/setup.py (example)

[github-actions]

Thank you for your contribution! This is very appreciated.

[fralau]

Thanks! In practice, how would you call python setup.py install for the test feature?

[lofidevops]

Good question 🤔 I must admit I didn't test that scenario. Let me play around and confirm it works. How do you do it at the moment? How do you do it with mkdocs_macros_plugin?

[lofidevops]

To do this from scratch:

cd mkdocs-mermaid2-plugin
virtualenv .venv --python=python3
./.venv/bin/pip install -e .[test]
./.venv/bin/python setup.py test

This installs mkdocs-mermaid2-plugin as an editable library in the virtualenv, with the testing prerequisites. (You can confirm that mkdocs-material and pyyaml both appear in .venv/lib.)

Although I'm pretty sure "setup.py test" is not doing anything. I'm not sure how you trigger your tests?

[fralau]

Thanks! If you use pip, would it work as follows?

pip install "mkdocs-mermaid2-plugin[test]"

[lofidevops]

Yes, that's how you would install it from PyPI.

[lofidevops]

Hmmm 🤔 if it's required for mkdocs-material users, not just for testing before release, then you probably want another extras definition so they can pip install mkdocs-mermaid2-plugin[material]. Or maybe that's simply a better name than test? Let me know.