{ "info": { "author": "Matthew Duck", "author_email": "matt@mattduck.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "gh2md\n=====\n\n|PyPI| |Travis|\n\nDump issues for a Github repository into a single markdown file. \n\nThere are various other projects that handle Github issue exports\n(Eg. `offline-issues `_), but I couldn't\nfind one that writes all issues, comments and metadata to a single readable\nfile.\n\n\nExample exports\n---------------\n\nAn example exported file is included in the `examples directory `_. \n\nDefault behaviour is to export all issues and open PRs. Closed PRs are ignored.\n\n\nUsage\n-----\n\nRun export for ``pope/ob-go``, prompting for login to ``mygithubuser``::\n\n gh2md pope/ob-go ob-go.md --login mygithubuser\n\n\nRun export for ``sarabander/sicp``, passing in token::\n\n gh2md sarabander/sicp sicp.md --token myAPItoken\n\n\nRun export for ``paulirish/git-open``, pulling token from environment::\n\n export GITHUB_ACCESS_TOKEN=myAPItoken\n gh2md paulirish/git-open git-open.md\n\n\nRun export for ``shezadkhan137/required``, pulling token from file::\n\n echo myAPItoken > ~/.github-token\n gh2md shezadkhan137/required required.md\n\n\nFull help::\n\n $ gh2md -h\n usage: gh2md [-h] [-l LOGIN_USER] [-t TOKEN] repo outpath\n\n Export Github repository issues and comments into a single\n markdown file. https://github.com/mattduck/gh2md.\n\n Credentials are resolved in the following order:\n\n - The --login flag always takes precedence and will prompt for this user.\n - The --token flag.\n - A `GITHUB_ACCESS_TOKEN` environment variable.\n - An API token stored in `~/.github-token`.\n\n positional arguments:\n repo Github repo to export, in format \"owner/repo_name\".\n outpath Path to write exported issues.\n\n optional arguments:\n -h, --help show this help message and exit\n -l LOGIN_USER, --login LOGIN_USER\n Prompt to login as this Github user. If provided, this\n takes precedence over any token found in the\n environment. If not provided and no token is found,\n you will be prompted to login as the repository owner.\n -t TOKEN, --token TOKEN\n Automatically login with this Github API token. If\n --login is provided, this is ignored.\n\n\nInstall\n-------\n\n``pip install gh2md``. Alternatively, clone the repository and run ``make install``.\n\n\nTODO\n-----\n\n- Improve performance. Currently fetching issues using PyGithub is slow - I\n assume it's possible to bulk-fetch most of the data.\n\n- Add flag to toggle inclusion of images.\n\n- Add arg(s) to control which data is exported - open/closed, issues/PRs.\n\n- Support 2FA login - currently if 2FA is enabled on your account you must setup\n an access token.\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/gh2md.svg\n :target: https://pypi.python.org/pypi/gh2md\n\n.. |Travis| image:: https://travis-ci.org/mattduck/gh2md.svg?branch=master\n :target: https://travis-ci.org/mattduck/gh2md\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mattduck/gh2md", "keywords": "github,issues,markdown", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "gh2md", "package_url": "https://pypi.org/project/gh2md/", "platform": "", "project_url": "https://pypi.org/project/gh2md/", "project_urls": { "Homepage": "https://github.com/mattduck/gh2md" }, "release_url": "https://pypi.org/project/gh2md/0.1.3/", "requires_dist": [ "PyGithub (~=1.34)", "retrying (==1.3.3)", "six" ], "requires_python": "", "summary": "Export Github repository issues to markdown files: https://github.com/mattduck/gh2md.", "version": "0.1.3" }, "last_serial": 2888987, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "306cf2334c089f7ec288d1db1406165c", "sha256": "2cd987519c7be2318669b939efa83601affdd631c034a145f27708638d963456" }, "downloads": -1, "filename": "gh2md-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "306cf2334c089f7ec288d1db1406165c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8945, "upload_time": "2017-05-20T17:58:32", "url": "https://files.pythonhosted.org/packages/8c/a3/50a5b59d4d9121bbca15c040d98675458491756eaefcef90b84cf0b10ae3/gh2md-0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1b27cc5654f282f68126163e31d06189", "sha256": "a226dc96dc1058ea1713f4b6a00986cf38c325fccfb5408fc96872660ecc5336" }, "downloads": -1, "filename": "gh2md-0.1.tar.gz", "has_sig": false, "md5_digest": "1b27cc5654f282f68126163e31d06189", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6579, "upload_time": "2017-05-20T17:58:35", "url": "https://files.pythonhosted.org/packages/12/47/6602f26e8de4822620a0272b2e08d19a486544e9a15a923eeb031d102780/gh2md-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4dba0fac9c23ff3aca506457538a51a5", "sha256": "d16437d7d0a936afd94031817d8d8ddb3823de1537f864f797c49670c503c142" }, "downloads": -1, "filename": "gh2md-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4dba0fac9c23ff3aca506457538a51a5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9171, "upload_time": "2017-05-21T12:29:17", "url": "https://files.pythonhosted.org/packages/97/db/00657a884654af2847b8f2f4b7f1556434686d33cb427b19d9580d59ce78/gh2md-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b4ab9f114fc20f2132d58cb793faab5c", "sha256": "14ae06c7e7c01c2cf52e3ed1864898ca20bfd7e9d7e33a8d277851ce56242c62" }, "downloads": -1, "filename": "gh2md-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b4ab9f114fc20f2132d58cb793faab5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6696, "upload_time": "2017-05-21T12:29:18", "url": "https://files.pythonhosted.org/packages/9f/f2/a6986f96fa0f72b8e6232e9b6732f2b72bc569681eb08744a31b38f0ba68/gh2md-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "2d3ab2711d91e4312e2675df3afcde0c", "sha256": "7236961fe8cf74ee3c4bcc8fef85b6852f43cb740145ca8acb362a61c0502010" }, "downloads": -1, "filename": "gh2md-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2d3ab2711d91e4312e2675df3afcde0c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9171, "upload_time": "2017-05-21T12:38:25", "url": "https://files.pythonhosted.org/packages/9e/15/f1a36b7b5f2d0687c928eb7e79dd014fb3055545b04c0ec40fed304a4555/gh2md-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4494234414784bb401c08b5c5446638", "sha256": "3159550d7c1960942c8633e78e94629e105217b910644a185a699e75c778d7ff" }, "downloads": -1, "filename": "gh2md-0.1.2.tar.gz", "has_sig": false, "md5_digest": "f4494234414784bb401c08b5c5446638", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6699, "upload_time": "2017-05-21T12:38:26", "url": "https://files.pythonhosted.org/packages/6c/2d/4ebb3bd998a5e15e3a97fff6ae918d4e228087041782a077c25d8422bb3b/gh2md-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "69741f9bf821738c0d12b45522e4b804", "sha256": "e986b749846df80dad3334fba2dd1830b5bcb2f89d87a65abb0471b531d782e0" }, "downloads": -1, "filename": "gh2md-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "69741f9bf821738c0d12b45522e4b804", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9169, "upload_time": "2017-05-21T12:50:27", "url": "https://files.pythonhosted.org/packages/64/22/c92ac9de4edce0a5e633d3e5dce34baf54022a1d32045a78bcbb156a8708/gh2md-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1b39a1fc4a397a38978b7f4e3e8ffa3f", "sha256": "7f3f5babd61fbbc08d894651cb5f9a8458702b5f7c7dae617fca7f04aeb208e9" }, "downloads": -1, "filename": "gh2md-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1b39a1fc4a397a38978b7f4e3e8ffa3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6701, "upload_time": "2017-05-21T12:50:29", "url": "https://files.pythonhosted.org/packages/e8/0b/0f0e347b10edea908aad23b88dffc68869a38258f28ff33692ea38571dc9/gh2md-0.1.3.tar.gz" } ], "0.1.4.dev0": [ { "comment_text": "", "digests": { "md5": "a1c896f56c15c829d914d2617d680d50", "sha256": "8c8c8b238822e4b9faabd06602a9dcd0a22c966043d082e1553d8bf08f01e880" }, "downloads": -1, "filename": "gh2md-0.1.4.dev0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a1c896f56c15c829d914d2617d680d50", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9264, "upload_time": "2017-05-21T15:19:22", "url": "https://files.pythonhosted.org/packages/4e/78/5a330e151a4ccb732fbc6ff5c81f7e717e2348b2c938440a63d6a29d9c8e/gh2md-0.1.4.dev0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3a5d1c34bdeca343286066140f1de93a", "sha256": "749dc8c0ca93e04072af03b9a1cca3dcc638b89eff275354c7df4b4a989d66d7" }, "downloads": -1, "filename": "gh2md-0.1.4.dev0.tar.gz", "has_sig": false, "md5_digest": "3a5d1c34bdeca343286066140f1de93a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6708, "upload_time": "2017-05-21T15:19:24", "url": "https://files.pythonhosted.org/packages/39/2d/b993d64b6ecb475cf995dd3afa1de4b5f862bb39daeed5ab9f8048fd67f3/gh2md-0.1.4.dev0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "69741f9bf821738c0d12b45522e4b804", "sha256": "e986b749846df80dad3334fba2dd1830b5bcb2f89d87a65abb0471b531d782e0" }, "downloads": -1, "filename": "gh2md-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "69741f9bf821738c0d12b45522e4b804", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9169, "upload_time": "2017-05-21T12:50:27", "url": "https://files.pythonhosted.org/packages/64/22/c92ac9de4edce0a5e633d3e5dce34baf54022a1d32045a78bcbb156a8708/gh2md-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1b39a1fc4a397a38978b7f4e3e8ffa3f", "sha256": "7f3f5babd61fbbc08d894651cb5f9a8458702b5f7c7dae617fca7f04aeb208e9" }, "downloads": -1, "filename": "gh2md-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1b39a1fc4a397a38978b7f4e3e8ffa3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6701, "upload_time": "2017-05-21T12:50:29", "url": "https://files.pythonhosted.org/packages/e8/0b/0f0e347b10edea908aad23b88dffc68869a38258f28ff33692ea38571dc9/gh2md-0.1.3.tar.gz" } ] }