{ "info": { "author": "Paul Joseph Davis", "author_email": "paul.joseph.davis@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "GitHub Pages Import\n===================\n\nAs part of [gunicorn][gunicorn], [Benoit Chesneau][benoit] and I have been\nstarting to look at how to host documentation. There's the obvious method of\nusing [GitHub's post-receive hook][github-post] to trigger doc builds and rsync\nto a webserver, but we ended up wanting to try out github's hosting to make the\nwhole interface a bit more robust.\n\n[GitHub Pages][gh-pages] is a pretty awesome service that GitHub provides for\nhosting project documentation. The only thing is that it requires a\n`gh-pages` branch that is the site's document root. This means that keeping\ndocumentation sources in the branch with code is a bit difficult. And it really\nturns into a head scratcher for things like [Sphinx][sphinx] that want to\naccess documentation sources and code sources at the same time.\n\nThen I stumbled across an interesting looking package called\n[github-tools][github-tools] that looked almost like what I wanted. It was a tad\ncomplicated and more involved than I wanted but it gave me an idear. Why not\njust write a script that can copy a directory to the `gh-pages` branch of the\nrepository. This saves me from even having to think about the branch and\neverything becomes magical.\n\nThis is what `ghp-import` was written for.\n\n[gunicorn]: http://www.gunicorn.com/ \"Gunicorn\"\n[benoit]: http://github.com/benoitc \"Beno\u00eet Chesneau\"\n[github-post]: https://help.github.com/articles/post-receive-hooks \"GitHub Post-Receive Hook\"\n[gh-pages]: http://pages.github.com/ \"GitHub Pages\"\n[sphinx]: http://sphinx.pocoo.org/ \"Sphinx Documentation\"\n[github-tools]: http://dinoboff.github.com/github-tools/ \"github-tools\"\n\n\nBig Fat Warning\n---------------\n\nThis will **DESTROY** your `gh-pages` branch. If you love it, you'll want to\ntake backups before playing with this. This script assumes that `gh-pages` is\n100% derivative. You should never edit files in your `gh-pages` branch by hand\nif you're using this script because you will lose your work.\n\nUsage\n-----\n\n Usage: ghp-import [OPTIONS] DIRECTORY\n\n\tOptions:\n\t -n Include a .nojekyll file in the branch.\n\t -c CNAME Write a CNAME file with the given CNAME.\n\t -m MESG The commit message to use on the target branch.\n\t -p Push the branch to origin/{branch} after committing.\n\t -f Force the push to the repository\n\t -r REMOTE The name of the remote to push to. [origin]\n\t -b BRANCH Name of the branch to write to. [gh-pages]\n\t -s Use the shell when invoking Git. [False]\n\t -l Follow symlinks when adding files. [False]\n\t -h, --help show this help message and exit\n\nIts pretty simple. Inside your repository just run `ghp-import $DOCS_DIR`\nwhere `$DOCS_DIR` is the path to the **built** documentation. This will write a\ncommit to your `gh-pages` branch with the current documents in it.\n\nIf you specify `-p` it will also attempt to push the `gh-pages` branch to\nGitHub. By default it'll just run `git push origin gh-pages`. You can specify\na different remote using the `-r` flag.\n\nYou can specify a different branch with `-b`. This is useful for user and\norganization page, which are served from the `master` branch.\n\nSome Windows users report needing to pass Git commands through the shell which can be accomplished by passing `-s`.\n\nThe `-l` option will cause the import to follow symlinks for users that have odd configurations that include symlinking outside of their documentation directory.\n\nLicense\n-------\n\n`ghp-import` is distributed under the Tumbolia Public License. See the LICENSE\nfile for more information.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/davisp/ghp-import", "keywords": null, "license": "Tumbolia Public License", "maintainer": null, "maintainer_email": null, "name": "ghp-import", "package_url": "https://pypi.org/project/ghp-import/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/ghp-import/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/davisp/ghp-import" }, "release_url": "https://pypi.org/project/ghp-import/0.5.5/", "requires_dist": null, "requires_python": null, "summary": "Copy your docs directly to the gh-pages branch.", "version": "0.5.5" }, "last_serial": 2668399, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "551bb41ac7623e16c715ddb149789c6c", "sha256": "76eba6e9f0ba8cabe5644408d3e830f34bc079980d1ef2f0ab3bb69fefa4329e" }, "downloads": -1, "filename": "ghp-import-0.1.tar.gz", "has_sig": false, "md5_digest": "551bb41ac7623e16c715ddb149789c6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3405, "upload_time": "2010-02-19T20:02:12", "url": "https://files.pythonhosted.org/packages/c7/c5/2b3f9a5bb4609a33433033e0df1fbce284a04e30b06cb13437351651a47e/ghp-import-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "566970bf91fd5ccd0d834edade76c85d", "sha256": "f67f5fd5f8463b30bfc1255614e5305d26f6f70a9c5e051995605c64d4803c39" }, "downloads": -1, "filename": "ghp-import-0.1.1.tar.gz", "has_sig": false, "md5_digest": "566970bf91fd5ccd0d834edade76c85d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3430, "upload_time": "2010-02-19T20:04:16", "url": "https://files.pythonhosted.org/packages/9b/08/3b97f012b552bac22baa83d937f9a5563bb2a65f7abae11326af03dc3e86/ghp-import-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "95d3e32d709ee874c9938ac866ea6ad0", "sha256": "e1d63209edb0864b52b75674db51ef06f9e1fe466daf6cee9aec9f69d1452828" }, "downloads": -1, "filename": "ghp-import-0.1.2.tar.gz", "has_sig": false, "md5_digest": "95d3e32d709ee874c9938ac866ea6ad0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3459, "upload_time": "2010-02-19T20:07:28", "url": "https://files.pythonhosted.org/packages/be/e4/9049df76131ed70b74a30dc4b3822d6c43133f3716b4eb6158515d28bc42/ghp-import-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "4f58fea8fd65b6570a85ccad4a34ab24", "sha256": "feb3e30eaf1c2e9eb8c2d367d182d61088f04c45d06668b52569d599ba4e34df" }, "downloads": -1, "filename": "ghp-import-0.1.3.tar.gz", "has_sig": false, "md5_digest": "4f58fea8fd65b6570a85ccad4a34ab24", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3637, "upload_time": "2010-02-19T21:12:06", "url": "https://files.pythonhosted.org/packages/eb/8b/03e06a073c8e03a45bc5d834482ec3b2d5ec9e1ce3ea69fd2d58dda92e92/ghp-import-0.1.3.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "e1b165d23cf415ad293abf17e5f6c5d5", "sha256": "6f909f7872f43296b6ccd09fe101d39aed94be4127384fe11be021ddda9cbd1b" }, "downloads": -1, "filename": "ghp-import-0.1.5.tar.gz", "has_sig": false, "md5_digest": "e1b165d23cf415ad293abf17e5f6c5d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3635, "upload_time": "2010-02-19T21:23:45", "url": "https://files.pythonhosted.org/packages/c1/06/12b78a1771248dce1ff02ebc6b368043d1beba541d2d8b7bac3c8323aef4/ghp-import-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "814906584126ca21c05c3ee30f0c428a", "sha256": "dd1b29402ce722f824ae5541bfe7256bdf2efda856e2977a888405d2519da06a" }, "downloads": -1, "filename": "ghp-import-0.1.6.tar.gz", "has_sig": false, "md5_digest": "814906584126ca21c05c3ee30f0c428a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3796, "upload_time": "2010-02-19T21:30:04", "url": "https://files.pythonhosted.org/packages/ef/95/1bf2538fae54ba75cf4caec0909cabf43f7ff7bf19f1cc2c76bb5cd03c42/ghp-import-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "026c515875700ec6f1a7d86e7e716b5e", "sha256": "05dedadc722e8a7a398e9d30c122423f5dcfd5c2ae8cd8caed9cd984ce62f5f2" }, "downloads": -1, "filename": "ghp-import-0.1.7.tar.gz", "has_sig": false, "md5_digest": "026c515875700ec6f1a7d86e7e716b5e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3764, "upload_time": "2010-03-07T19:40:50", "url": "https://files.pythonhosted.org/packages/87/c8/67cf4c07c58d39357ce86093a6a406da2856639e33e4442266f4da927ccd/ghp-import-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "f8cf8d77db1ad77d850c590ff8c9daa9", "sha256": "fb5d156f841359426f466d10b98477a1df9c2342be96d6addd0a6695b735238f" }, "downloads": -1, "filename": "ghp-import-0.1.8.tar.gz", "has_sig": false, "md5_digest": "f8cf8d77db1ad77d850c590ff8c9daa9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4189, "upload_time": "2010-03-07T19:41:53", "url": "https://files.pythonhosted.org/packages/4e/9e/4290d23a26fcb4e31dbc2b28c31ec025a89fbce8ff7a34a222eeb06cfb6a/ghp-import-0.1.8.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "398fc80ec9743f10dca8eb7bce7f0a59", "sha256": "95d60aa28ae09683a87fc3e1fc7ae71fae0861395637f7ae34c2e6b92ba47166" }, "downloads": -1, "filename": "ghp-import-0.2.0.tar.gz", "has_sig": false, "md5_digest": "398fc80ec9743f10dca8eb7bce7f0a59", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4573, "upload_time": "2013-01-10T07:36:38", "url": "https://files.pythonhosted.org/packages/5c/06/1068d3dc75ed78de68374eb651979ceda12e88f54e1e4a5609cc328704a4/ghp-import-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "41cff4daa5bb7ac596524ff6f666883f", "sha256": "0a16c30423ca5a8de0d9eabc956680e1d3c3ec7a0dbc88e2743083ad88bdf272" }, "downloads": -1, "filename": "ghp-import-0.2.1.tar.gz", "has_sig": false, "md5_digest": "41cff4daa5bb7ac596524ff6f666883f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4474, "upload_time": "2013-01-14T18:34:07", "url": "https://files.pythonhosted.org/packages/f7/c0/ebc000b4476f9921b841a7918b3876d5c6974a79d16df310f5094922e771/ghp-import-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "82c65f0d504548b1c37bfa3ff45ca6f8", "sha256": "c241e13f8407ce27cddf67100286c8e4036c94d35ceb21314842fbd36c386efc" }, "downloads": -1, "filename": "ghp-import-0.2.2.tar.gz", "has_sig": false, "md5_digest": "82c65f0d504548b1c37bfa3ff45ca6f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4694, "upload_time": "2013-01-17T03:13:26", "url": "https://files.pythonhosted.org/packages/fa/dc/212236b9b2a981275509b5b2b5ba6bdd2ad16fd0c70b64168a2babf5872a/ghp-import-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "68f717c362018afb49721ce0dd8f7915", "sha256": "3084730c4a7e5e767ca612808e6766db9ab0c02aa357029b2bc48b1cec00f360" }, "downloads": -1, "filename": "ghp-import-0.2.3.tar.gz", "has_sig": false, "md5_digest": "68f717c362018afb49721ce0dd8f7915", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4727, "upload_time": "2013-07-23T08:51:55", "url": "https://files.pythonhosted.org/packages/9d/e2/c8a4504dcbc9c291da3964787d8a048e61583f284838e3f9b77788e189f0/ghp-import-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "e6721ca0ea895b29983344d5cb184804", "sha256": "b29df9559fefa855731c7dd0c5a31418cdfc3a87eb3028588b88c4ecb4f47483" }, "downloads": -1, "filename": "ghp-import-0.2.4.tar.gz", "has_sig": false, "md5_digest": "e6721ca0ea895b29983344d5cb184804", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4872, "upload_time": "2013-08-20T22:08:26", "url": "https://files.pythonhosted.org/packages/8f/1b/55543262779d90c8f917488ebcc6aadf5712ae234fe892043e0847fc9b27/ghp-import-0.2.4.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "10cdce9eb0c54c588669008a57854d98", "sha256": "a408c1023e844fc2f9ab2955658692658366809aca01332c9ec90494f20d3ee6" }, "downloads": -1, "filename": "ghp-import-0.3.0.tar.gz", "has_sig": false, "md5_digest": "10cdce9eb0c54c588669008a57854d98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4940, "upload_time": "2013-08-21T20:08:38", "url": "https://files.pythonhosted.org/packages/e2/ac/caf93b381aac2b515e985b84c371105b9c13f1998fb09215da43bf2829fb/ghp-import-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "beaa2fe3dd150a0e56470f2ff0721033", "sha256": "0b90dcc7c0361c67c7682357ac8f54e22b560a03ec83229d66c2ff556c029850" }, "downloads": -1, "filename": "ghp-import-0.3.1.tar.gz", "has_sig": false, "md5_digest": "beaa2fe3dd150a0e56470f2ff0721033", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4845, "upload_time": "2013-08-31T21:09:50", "url": "https://files.pythonhosted.org/packages/76/cc/13a0874a4aaf0661ae1fa127e2e84e5f901c8ba423373a4dbd26f37b9f76/ghp-import-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "67821089a324533d719eadf10cc31c1e", "sha256": "fcc79c8da769a3c4c39520ceb2e571c00fb6c68c312a8873b9c8638d0ffbaa40" }, "downloads": -1, "filename": "ghp-import-0.3.2.tar.gz", "has_sig": false, "md5_digest": "67821089a324533d719eadf10cc31c1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4854, "upload_time": "2013-09-17T16:16:19", "url": "https://files.pythonhosted.org/packages/ae/72/d2148e16ce8e0ee4e8e4c5d24d88550bee179acdccb6470b2f9e67f1880a/ghp-import-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "3408e7c835e00d92026add2806e91a8d", "sha256": "08238409a04c1cbae0fb2bd9fd1d2a9231902e207bf80e71c541ad11a0177c65" }, "downloads": -1, "filename": "ghp-import-0.4.0.tar.gz", "has_sig": false, "md5_digest": "3408e7c835e00d92026add2806e91a8d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4989, "upload_time": "2014-01-07T20:12:33", "url": "https://files.pythonhosted.org/packages/83/2c/f0986ce6e40a7d971979aacc79d4c33adee1551b433dcc52e5d88abdf2cf/ghp-import-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "99e018372990c03ab355aa62c34965c5", "sha256": "6058810e1c46dd3b5b1eee87e203bdfbd566e10cfc77566edda7aa4dbf6a3053" }, "downloads": -1, "filename": "ghp-import-0.4.1.tar.gz", "has_sig": false, "md5_digest": "99e018372990c03ab355aa62c34965c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5002, "upload_time": "2014-02-19T21:22:04", "url": "https://files.pythonhosted.org/packages/08/17/9847c2be67ef5af9d10835610c59138b37229e0cb296899bdafb4dbd603d/ghp-import-0.4.1.tar.gz" } ], "0.4.2": [], "0.5.0": [ { "comment_text": "", "digests": { "md5": "80924288e36d8fe6d880d5d4d7e5a555", "sha256": "df0747cfcb1f46409ddb3c6eaa7c4ca58d2a86bd6108f41c07c5d613a3d5638e" }, "downloads": -1, "filename": "ghp-import-0.5.0.tar.gz", "has_sig": false, "md5_digest": "80924288e36d8fe6d880d5d4d7e5a555", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5124, "upload_time": "2016-12-16T17:47:29", "url": "https://files.pythonhosted.org/packages/b4/6f/e1c8736f7c61633dc04f997f6abc5226e28d3a7c66c5289dda5fdbb5c0ee/ghp-import-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "51eaedca33a3ae3c773415fbd3708098", "sha256": "5b38f58634f0125eac0013342c77d534516fabd153435a89bdbf2f4b5e54afb8" }, "downloads": -1, "filename": "ghp-import-0.5.1.tar.gz", "has_sig": false, "md5_digest": "51eaedca33a3ae3c773415fbd3708098", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5365, "upload_time": "2016-12-18T18:49:28", "url": "https://files.pythonhosted.org/packages/8d/06/ec035658bf81f814553c86c10a60a345a7820fa6c23c695e5214f9be1f3e/ghp-import-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "9736c69912a4fd6c986c0f36de8e4daf", "sha256": "ca4f5bf637b62ec399920bb945cef7f8d983d52ce155821b04c724166f6e79b0" }, "downloads": -1, "filename": "ghp-import-0.5.2.tar.gz", "has_sig": false, "md5_digest": "9736c69912a4fd6c986c0f36de8e4daf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5363, "upload_time": "2016-12-18T18:53:49", "url": "https://files.pythonhosted.org/packages/9e/86/4c56850afc34714502082f9d46091dec7c951d135795a16d89b1541f4865/ghp-import-0.5.2.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "23925d2067a3e8b787a2f55c4e526c1f", "sha256": "0cb2083916aae1e5e6b94a324242c0330fa16e682c819f88464f1c5ae0e7eed8" }, "downloads": -1, "filename": "ghp-import-0.5.3.tar.gz", "has_sig": false, "md5_digest": "23925d2067a3e8b787a2f55c4e526c1f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5536, "upload_time": "2016-12-18T19:02:34", "url": "https://files.pythonhosted.org/packages/99/bc/4e7256da52e6322ae64d7effbfe495eb7c1cb309a6876e02aa033c239151/ghp-import-0.5.3.tar.gz" } ], "0.5.4": [ { "comment_text": "", "digests": { "md5": "70417075b2e44c3bee768a2d6eb1a441", "sha256": "65d576f107e2a52abdd10866476053a8c2c8ad7e2148a62bc0bc23f501b924cc" }, "downloads": -1, "filename": "ghp-import-0.5.4.tar.gz", "has_sig": false, "md5_digest": "70417075b2e44c3bee768a2d6eb1a441", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5597, "upload_time": "2016-12-18T19:11:25", "url": "https://files.pythonhosted.org/packages/f5/cd/c780b2248dd364fdc77837a020bad3e176933d7ce5643217d9475465e871/ghp-import-0.5.4.tar.gz" } ], "0.5.5": [ { "comment_text": "", "digests": { "md5": "89cfba26ee012115ddc290bac124a590", "sha256": "3e924ea720e4e1f82d56753db2154bfb86067472c5830732159c3a4c4fbc75d7" }, "downloads": -1, "filename": "ghp-import-0.5.5.tar.gz", "has_sig": false, "md5_digest": "89cfba26ee012115ddc290bac124a590", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5642, "upload_time": "2017-02-26T02:06:44", "url": "https://files.pythonhosted.org/packages/bd/95/27cb11b5d09643c2756f04a1412b0d62aadeb0b909564f85122270c4097c/ghp-import-0.5.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "89cfba26ee012115ddc290bac124a590", "sha256": "3e924ea720e4e1f82d56753db2154bfb86067472c5830732159c3a4c4fbc75d7" }, "downloads": -1, "filename": "ghp-import-0.5.5.tar.gz", "has_sig": false, "md5_digest": "89cfba26ee012115ddc290bac124a590", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5642, "upload_time": "2017-02-26T02:06:44", "url": "https://files.pythonhosted.org/packages/bd/95/27cb11b5d09643c2756f04a1412b0d62aadeb0b909564f85122270c4097c/ghp-import-0.5.5.tar.gz" } ] }