| Name | mkdocs-get-deps JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | MkDocs extension that lists all dependencies according to a mkdocs.yml file |
| upload_time | 2023-11-20 17:51:09 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
mkdocs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-get-deps
**An extra command for [MkDocs][] that infers required PyPI packages from `plugins` in mkdocs.yml.**
[](https://pypi.org/project/mkdocs-get-deps/)
[](https://github.com/mkdocs/get-deps/blob/master/LICENSE.md)
[](https://github.com/mkdocs/get-deps/actions?query=event%3Apush+branch%3Amaster)
<table>
<tr><td>Installation:</td><td>Alternatively through MkDocs itself:</td></tr>
<tr><td>
```bash
pip install mkdocs-get-deps
```
</td><td>
```bash
pip install mkdocs
```
</td>
</tr></table>
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:
<table>
<tr><td>Usage:</td><td>Alternatively through MkDocs itself:</td></tr>
<tr><td>
```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)
```
</td><td>
```bash
mkdocs get-deps
mkdocs get-deps > requirements.txt
pip install -r requirements.txt
pip install $(mkdocs get-deps)
```
</td>
</tr></table>
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`](https://www.mkdocs.org/user-guide/cli/#mkdocs-get-deps).
## MkDocs' official catalog of plugins
Check out <https://github.com/mkdocs/catalog> 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/
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-get-deps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "mkdocs",
"author": "",
"author_email": "Oleh Prypin <oleh@pryp.in>",
"download_url": "https://files.pythonhosted.org/packages/98/f5/ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b/mkdocs_get_deps-0.2.0.tar.gz",
"platform": null,
"description": "# mkdocs-get-deps\n\n**An extra command for [MkDocs][] that infers required PyPI packages from `plugins` in mkdocs.yml.**\n\n[](https://pypi.org/project/mkdocs-get-deps/)\n[](https://github.com/mkdocs/get-deps/blob/master/LICENSE.md)\n[](https://github.com/mkdocs/get-deps/actions?query=event%3Apush+branch%3Amaster)\n\n<table>\n<tr><td>Installation:</td><td>Alternatively through MkDocs itself:</td></tr>\n<tr><td>\n\n```bash\npip install mkdocs-get-deps\n```\n\n</td><td>\n\n```bash\npip install mkdocs\n```\n\n</td>\n</tr></table>\n\n\nThis 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:\n\n<table>\n<tr><td>Usage:</td><td>Alternatively through MkDocs itself:</td></tr>\n<tr><td>\n\n```bash\n# Print dependencies of the current project\nmkdocs-get-deps\n# Save them into a file\nmkdocs-get-deps > requirements.txt\n# Install dependencies on the fly\npip install $(mkdocs-get-deps)\n```\n\n</td><td>\n\n```bash\n\nmkdocs get-deps\n\nmkdocs get-deps > requirements.txt\npip install -r requirements.txt\n\npip install $(mkdocs get-deps)\n```\n\n</td>\n</tr></table>\n\nThe 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.\n\nThe 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).\n\nOf 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.\n\nThe 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`](https://www.mkdocs.org/user-guide/cli/#mkdocs-get-deps).\n\n## MkDocs' official catalog of plugins\n\nCheck out <https://github.com/mkdocs/catalog> and add all your general-purpose plugins, themes and extensions there, so that they can be looked up through `mkdocs get-deps`.\n\n[MkDocs]: https://www.mkdocs.org/\n[`mkdocs.yml`]: https://www.mkdocs.org/user-guide/configuration/\n",
"bugtrack_url": null,
"license": "",
"summary": "MkDocs extension that lists all dependencies according to a mkdocs.yml file",
"version": "0.2.0",
"project_urls": {
"History": "https://github.com/mkdocs/get-deps/releases",
"Issues": "https://github.com/mkdocs/get-deps/issues",
"Source": "https://github.com/mkdocs/get-deps"
},
"split_keywords": [
"mkdocs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9fd4029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea",
"md5": "1c190eaf5967d4e29451a7259bea1141",
"sha256": "2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134"
},
"downloads": -1,
"filename": "mkdocs_get_deps-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c190eaf5967d4e29451a7259bea1141",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9521,
"upload_time": "2023-11-20T17:51:08",
"upload_time_iso_8601": "2023-11-20T17:51:08.587799Z",
"url": "https://files.pythonhosted.org/packages/9f/d4/029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea/mkdocs_get_deps-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98f5ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b",
"md5": "4144c380f8bea5be5e5da35e3d82984b",
"sha256": "162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c"
},
"downloads": -1,
"filename": "mkdocs_get_deps-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4144c380f8bea5be5e5da35e3d82984b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10239,
"upload_time": "2023-11-20T17:51:09",
"upload_time_iso_8601": "2023-11-20T17:51:09.981677Z",
"url": "https://files.pythonhosted.org/packages/98/f5/ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b/mkdocs_get_deps-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 17:51:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mkdocs",
"github_project": "get-deps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-get-deps"
}
