ghp-import
Copy your docs directly to the gh-pages branch.
Decision gist · record as of 2026-08-14
Yes, if you need to automate GitHub Pages deployment and are comfortable with dormant maintenance status. The tool is stable and widely used (top 5000 on PyPI), has no known vulnerabilities, and low install friction. Verify compatibility with your current Git version and authentication setup before relying on it in a new CI/CD pipeline.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Git to be installed and available on the system PATH; the package wraps Git commands to manage the gh-pages branch.
- Low friction: single pure-Python wheel with one lightweight runtime dependency (python-dateutil).
- Maintenance is dormant—last release May 2022—but the repository remains active with 626 stars, suggesting the tool is stable enough that active development has ceased rather than stalled.
License · maintenance · safety
Apache Software License (permissive) — Apache Software License (permissive) means you can use, modify, and distribute this package freely in commercial and private projects, with only the requirement to include a copy of the license and state any changes made.
last release 2022-05-02 (1565 days) · last repo commit 2024-02-08 · 626 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 17,246,991 downloads/mo, #1,126 on PyPI
Alternatives
Verify before relying
pip install ghp-import
from ghp_import import ghp_import
ghp_import('docs', push=True, cname='example.com')- Whether the package works reliably with modern Git versions and GitHub's current authentication requirements (SSH keys, personal access tokens).
- Compatibility with recent Python versions beyond what classifiers indicate, given dormant maintenance status since 2022.
What it is and what it does
ghp-import takes a local documentation directory and commits it to the gh-pages branch with a single command or function call, solving the problem of managing a separate branch for GitHub Pages hosting. It wraps Git operations and provides both a CLI interface and a Python API, optionally pushing the branch to a remote repository, writing CNAME records, and adding .nojekyll files to disable Jekyll processing.
The package depends only on python-dateutil and runs as a pure-Python wheel, making installation straightforward. It treats the gh-pages branch as fully derivative—it will overwrite the branch's contents on each run unless a prefix is specified—so it assumes documentation is regenerated and re-imported as part of a build workflow rather than edited directly.
Use it for
- Publish Sphinx documentation output to GitHub Pages as part of a build workflow.
- Deploy static site generator output to GitHub Pages without manual branch management.
- Set up custom domain hosting on GitHub Pages by writing CNAME records during deployment.
- Maintain a clean gh-pages history by using the no-history flag to avoid repository bloat.
- Deploy documentation to organization or user pages by specifying a different branch instead of gh-pages.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need to automate GitHub Pages deployment and are comfortable with dormant maintenance status.
The tool is stable and widely used (top 5000 on PyPI), has no known vulnerabilities, and low install friction. Verify compatibility with your current Git version and authentication setup before relying on it in a new CI/CD pipeline.
Install
ghp-import on PyPI
Before you install
Low friction: single pure-Python wheel with one lightweight runtime dependency (python-dateutil). Maintenance is dormant—last release May 2022—but the repository remains active with 626 stars, suggesting the tool is stable enough that active development has ceased rather than stalled.
Requires Git to be installed and available on the system PATH; the package wraps Git commands to manage the gh-pages branch.
License in practice
Apache Software License (permissive) means you can use, modify, and distribute this package freely in commercial and private projects, with only the requirement to include a copy of the license and state any changes made.
Quickstart
pip install ghp-import
from ghp_import import ghp_import
ghp_import('docs', push=True, cname='example.com')Verify before relying
- Whether the package works reliably with modern Git versions and GitHub's current authentication requirements (SSH keys, personal access tokens).
- Compatibility with recent Python versions beyond what classifiers indicate, given dormant maintenance status since 2022.
Package facts
| License | Apache Software License permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagepython-dateutil |
| Maintenance | Dormant 1,565 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 17,246,991 / month, #1,126 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 2Programming Language :: Python :: 3 |
Evidence: ghp_import-2.1.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “github pages deployment”
- ghp-importAutomates publishing built documentation to GitHub Pages by managing…
- mikemike deploys multiple versions of MkDocs-generated documentation to a…
- Frozen-FlaskConverts a Flask application into a directory of static files that…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mike · ghstack · mkdocs-multirepo-plugin · release-tag · mkdocs-redirects · readthedocs-sphinx-ext · sphinx-reredirects · git-remote-s3 · sphinx-inline-tabs · tbump