{"id":15017426,"url":"https://github.com/mkdocs/get-deps","last_synced_at":"2025-10-19T14:32:26.421Z","repository":{"id":208082160,"uuid":"720787278","full_name":"mkdocs/get-deps","owner":"mkdocs","description":"An extra command for MkDocs that infers required PyPI packages from `plugins` in mkdocs.yml","archived":false,"fork":false,"pushed_at":"2024-02-11T18:55:11.000Z","size":27,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-04T07:37:12.356Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"oprypin"}},"created_at":"2023-11-19T15:50:28.000Z","updated_at":"2024-04-06T01:42:18.000Z","dependencies_parsed_at":"2024-09-16T08:53:37.465Z","dependency_job_id":null,"html_url":"https://github.com/mkdocs/get-deps","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"9a0f53e07367863e55ef057796d167cabac1443b"},"previous_names":["mkdocs/get-deps"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fget-deps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fget-deps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fget-deps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fget-deps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocs","download_url":"https://codeload.github.com/mkdocs/get-deps/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237152832,"owners_count":19263792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T19:50:26.985Z","updated_at":"2025-10-19T14:32:21.131Z","avatar_url":"https://github.com/mkdocs.png","language":"Python","readme":"# mkdocs-get-deps\n\n**An extra command for [MkDocs][] that infers required PyPI packages from `plugins` in mkdocs.yml.**\n\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-get-deps)](https://pypi.org/project/mkdocs-get-deps/)\n[![License](https://img.shields.io/github/license/mkdocs/get-deps)](https://github.com/mkdocs/get-deps/blob/master/LICENSE.md)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mkdocs/get-deps/ci.yml.svg)](https://github.com/mkdocs/get-deps/actions?query=event%3Apush+branch%3Amaster)\n\n\u003ctable\u003e\n\u003ctr\u003e\u003ctd\u003eInstallation:\u003c/td\u003e\u003ctd\u003eAlternatively through MkDocs itself:\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```bash\npip install mkdocs-get-deps\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```bash\npip install mkdocs\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\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\u003ctable\u003e\n\u003ctr\u003e\u003ctd\u003eUsage:\u003c/td\u003e\u003ctd\u003eAlternatively through MkDocs itself:\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\n\n```bash\n# Print dependencies of the current project\nmkdocs-get-deps\n# Save them into a file\nmkdocs-get-deps \u003e requirements.txt\n# Install dependencies on the fly\npip install $(mkdocs-get-deps)\n```\n\n\u003c/td\u003e\u003ctd\u003e\n\n```bash\n\nmkdocs get-deps\n\nmkdocs get-deps \u003e requirements.txt\npip install -r requirements.txt\n\npip install $(mkdocs get-deps)\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\u003c/table\u003e\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 \u003chttps://github.com/mkdocs/catalog\u003e 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","funding_links":["https://github.com/sponsors/oprypin"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fget-deps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocs%2Fget-deps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fget-deps/lists"}