python-mkdocs-get-deps
Port variant v12
Summary List dependencies from by mydocs.yml file (3.12)
Package version 0.2.0
Homepage https://github.com/mkdocs/get-deps
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v13
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 14 JAN 2025, 19:34:39 UTC
Port created 22 APR 2024, 23:12:51 UTC
Subpackage Descriptions
single # mkdocs-get-deps **An extra command for [MkDocs][] that infers required PyPI packages from `plugins` in mkdocs.yml.** [PyPI] [GitHub] [GitHub Workflow Status]
Installation:Alternatively through MkDocs itself:
```bash pip install mkdocs-get-deps ``` `bash pip install mkdocs `
This command guesses the Python dependencies that a MkDocs site requires in order to build. It simply prints the PyPI packages that need to be installed. In the terminal it can be combined directly with a `pip install` command, as per the last example below:
Usage:Alternatively through MkDocs itself:
```bash # Print dependencies of the current project mkdocs-get-deps # Save them into a file mkdocs-get-deps > requirements.txt # Install dependencies on the fly pip install $(mkdocs-get-deps) ``` ```bash mkdocs get-deps mkdocs get-deps > requirements.txt pip install -r requirements.txt pip install $(mkdocs get-deps) ```
The idea is that right after running this command, you can directly follow it up with `mkdocs build` and it will almost always "just work", without needing to think which dependencies to install. The way it works is by scanning [`mkdocs.yml`] for `themes:`, `plugins:`, `markdown_extensions:` items and doing a reverse lookup based on a large list of known projects (catalog, see below). Of course, you're encouraged to use a "virtualenv" with such a command. Also note that for environments that require stability (for example CI) directly installing deps in this way is not a very reliable approach as it precludes dependency pinning. The command allows overriding which config file is used (instead of `mkdocs.yml` in the current directory) as well as which catalog of projects is used (instead of downloading it from the default location). See [`mkdocs get-deps --help`]. ## MkDocs' official catalog of plugins Check out and add all your general-purpose plugins, themes and extensions there, so that they can be looked up through `mkdocs get-deps`. [MkDocs]: https://www.mkdocs.org/ [`mkdocs.yml`]: https://www.mkdocs.org/user-guide/configuration/
Configuration Switches (platform-specific settings discarded)
PY312 ON Build using Python 3.12 PY313 OFF Build using Python 3.13
Package Dependencies by Type
Build (only) python312:dev:std
python-pip:single:v12
autoselect-python:single:std
Build and Runtime python312:primary:std
Runtime (only) python-mergedeep:single:v12
python-platformdirs:single:v12
python-PyYAML:single:v12
Download groups
main mirror://PYPIWHL/9f/d4/029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea
Distribution File Information
2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134 9521 python-src/mkdocs_get_deps-0.2.0-py3-none-any.whl
Ports that require python-mkdocs-get-deps:v12
python-mkdocs:v12 Project documentation with Markdown (3.12)