[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://www.python.org/)
# Introduction
A simple python console script to let me convert [GitHub Closed Issues](https://docs.github.com/en/github-cli) output to [Markdown](https://www.howtogeek.com/448323/what-is-markdown-and-how-do-you-use-it/).
Typically after working a multi-repository project I want to know the issues in each repository that have been fixed since the last release.
It produces output in the following format:
```markdown
* [121](https://api.github.com/repos/hasii2011/pytrek/issues/121) Implement Move automatic
* [120](https://api.github.com/repos/hasii2011/pytrek/issues/120) Fixing of devices is not asynchronous
* [119](https://api.github.com/repos/hasii2011/pytrek/issues/119) We should only have a single Super Commander
```
# Overview
The basic command structure is:
```
Usage: pygh2md [OPTIONS]
slug A repository slug in the format <user-name>/repository-name;
e.g., `hasii2011/TestRepository`
sinceDate The start date to query for closed issues; Format yyyy-mm-
dd; e.g., 2024-03-01
output_file The filename for the markdown output file
appends If `True` append this script's output (default is True)
Options:
--version Show the version and exit.
-s, --slug TEXT GitHub slugs to query [required]
-d, --since-date TEXT The date from which we want to start searching.
[required]
-o, --output-file TEXT The output markdown file. [required]
-a, --append Append to output file
--help Show this message and exit.
```
A simple example:
```bash
pygh2md -s hasii2011/pytrek -d 2024-06-01 -o PytrekClosedIssues.md
```
# Installation
```bash
pip install pygh2md
```
___
Written by Humberto A. Sanchez II <mailto@humberto.a.sanchez.ii@gmail.com>, (C) 2024
## Note
For all kind of problems, requests, enhancements, bug reports, etc.,
please drop me an e-mail.
------
I am concerned about GitHub's Copilot project
I urge you to read about the
[Give up GitHub](https://GiveUpGitHub.org) campaign from
[the Software Freedom Conservancy](https://sfconservancy.org).
While I do not advocate for all the issues listed there I do not like that
a company like Microsoft may profit from open source projects.
I continue to use GitHub because it offers the services I need for free. But, I continue
to monitor their terms of service.
Any use of this project's code by GitHub Copilot, past or present, is done
without my permission. I do not consent to GitHub's use of this project's
code in Copilot.
Raw data
{
"_id": null,
"home_page": null,
"name": "pygh2md",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "\"Humberto A. Sanchez II\" <Humbert.A.Sanchez.II@gmail.com>",
"keywords": "git, issue management, markdown, python",
"author": null,
"author_email": "\"Humberto A. Sanchez II\" <Humbert.A.Sanchez.II@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/eb/83/460aed4e5345f10ca00a3e4fe16b359c3c513c7da1b722255eade41f4861/pygh2md-0.1.0.tar.gz",
"platform": null,
"description": "\n[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)\n[](https://www.python.org/)\n\n# Introduction\n\nA simple python console script to let me convert [GitHub Closed Issues](https://docs.github.com/en/github-cli) output to [Markdown](https://www.howtogeek.com/448323/what-is-markdown-and-how-do-you-use-it/).\n\nTypically after working a multi-repository project I want to know the issues in each repository that have been fixed since the last release. \n\nIt produces output in the following format:\n\n```markdown\n* [121](https://api.github.com/repos/hasii2011/pytrek/issues/121) Implement Move automatic \n* [120](https://api.github.com/repos/hasii2011/pytrek/issues/120) Fixing of devices is not asynchronous \n* [119](https://api.github.com/repos/hasii2011/pytrek/issues/119) We should only have a single Super Commander \n```\n\n# Overview\n\nThe basic command structure is:\n\n```\nUsage: pygh2md [OPTIONS]\n\n slug A repository slug in the format <user-name>/repository-name;\n e.g., `hasii2011/TestRepository`\n\n sinceDate The start date to query for closed issues; Format yyyy-mm-\n dd; e.g., 2024-03-01\n\n output_file The filename for the markdown output file\n\n appends If `True` append this script's output (default is True)\n\nOptions:\n --version Show the version and exit.\n -s, --slug TEXT GitHub slugs to query [required]\n -d, --since-date TEXT The date from which we want to start searching.\n [required]\n -o, --output-file TEXT The output markdown file. [required]\n -a, --append Append to output file\n --help Show this message and exit.\n```\n\n\nA simple example:\n\n```bash\npygh2md -s hasii2011/pytrek -d 2024-06-01 -o PytrekClosedIssues.md\n```\n\n# Installation\n\n```bash\npip install pygh2md\n```\n\n___\n\nWritten by Humberto A. Sanchez II <mailto@humberto.a.sanchez.ii@gmail.com>, (C) 2024\n\n\n## Note\nFor all kind of problems, requests, enhancements, bug reports, etc.,\nplease drop me an e-mail.\n\n\n------\n\n\n\n\nI am concerned about GitHub's Copilot project\n\n\n\nI urge you to read about the\n[Give up GitHub](https://GiveUpGitHub.org) campaign from\n[the Software Freedom Conservancy](https://sfconservancy.org).\n\nWhile I do not advocate for all the issues listed there I do not like that\na company like Microsoft may profit from open source projects.\n\nI continue to use GitHub because it offers the services I need for free. But, I continue\nto monitor their terms of service.\n\nAny use of this project's code by GitHub Copilot, past or present, is done\nwithout my permission. I do not consent to GitHub's use of this project's\ncode in Copilot.\n",
"bugtrack_url": null,
"license": "GNU AFFERO GENERAL PUBLIC LICENSE",
"summary": "Convert Git Issue to Markdown",
"version": "0.1.0",
"project_urls": {
"Repository": "https://github.com/hasii2011/pygh2md"
},
"split_keywords": [
"git",
" issue management",
" markdown",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2bdae55821cf52702253b61ccdcb39e6e69a95571446fdca707b5ff75ec97296",
"md5": "6b2566b8775d73e86f9ea545e678f5ae",
"sha256": "7164b31079f23eab04ca68f1bc23f0cc7ab78d66b80042b670daf2d77ba02ade"
},
"downloads": -1,
"filename": "pygh2md-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b2566b8775d73e86f9ea545e678f5ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19301,
"upload_time": "2024-09-13T03:02:58",
"upload_time_iso_8601": "2024-09-13T03:02:58.290823Z",
"url": "https://files.pythonhosted.org/packages/2b/da/e55821cf52702253b61ccdcb39e6e69a95571446fdca707b5ff75ec97296/pygh2md-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb83460aed4e5345f10ca00a3e4fe16b359c3c513c7da1b722255eade41f4861",
"md5": "d8a601dd8d68911eba8c9ee6f8c48b5c",
"sha256": "319dc6605dcec7149ee59d02c49000d7b335ea1e0e5afcdbf7e97088884c3483"
},
"downloads": -1,
"filename": "pygh2md-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d8a601dd8d68911eba8c9ee6f8c48b5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18829,
"upload_time": "2024-09-13T03:03:00",
"upload_time_iso_8601": "2024-09-13T03:03:00.076775Z",
"url": "https://files.pythonhosted.org/packages/eb/83/460aed4e5345f10ca00a3e4fe16b359c3c513c7da1b722255eade41f4861/pygh2md-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 03:03:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hasii2011",
"github_project": "pygh2md",
"github_not_found": true,
"lcname": "pygh2md"
}
JSON
