{
"info": {
"author": "Glen Jarvis",
"author_email": "glen@glenjarvis.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: End Users/Desktop",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6"
],
"description": "====================\ngithub_commit_status\n====================\n\nA simple command line for updating a commit's status in GitHub\n\nProject and Build Status\n------------------------\n\n.. image:: https://travis-ci.org/glenjarvis/github_commit_status.svg?branch=master\n :target: https://travis-ci.org/glenjarvis/github_commit_status\n :alt: Travis tests\n\n.. image:: https://pyup.io/repos/github/glenjarvis/github_commit_status/shield.svg\n :target: https://pyup.io/repos/github/glenjarvis/github_commit_status/\n :alt: Updates\n\n.. image:: https://pyup.io/repos/github/glenjarvis/github_commit_status/python-3-shield.svg\n :target: https://pyup.io/repos/github/glenjarvis/github_commit_status/\n :alt: Python 3\n\n.. image:: https://readthedocs.org/projects/github_commit_status/badge/?version=latest\n :target: http://github_commit_status.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://ci.appveyor.com/api/projects/status/github/glenjarvis/github_commit_status?branch=master&svg=true\n :target: https://ci.appveyor.com/project/glenjarvis/github_commit_status/branch/master\n :alt: Windows build status on Appveyor\n\n* `GitHub repo `_\n* `Online Documentation `_\n* `Free Software `_\n\n\nHow to Use\n----------\n\nBackground and Purpose\n^^^^^^^^^^^^^^^^^^^^^^\n\nIn GitHub, Pull Requests can have some checks against the code in question.\nThis is a great way to check for things such as white space, coding standards,\netc. Continuous Integration tools, like Travis, use this to update the status\nof the commit that you see in Pull Requests in GitHub.\n\n`Pull Request Example `_\n\nThis is a fairly simple integration and you can also place your own checks here.\nIn the following example, I made the status pending with a yellow circle with\nthe phrase \"You know you can change this, right?\"\n\n`Custom Status Example `_\n\nThis command line tool will allow you to update the status of any commit that\nyou have access to in GitHub. It was built to be a teaching tool for a course\non Source Control Management (Git) and GitHub integrations. However, it is\nstable and can be used in production seamlessly -- especially environments\nwhere it makes sense to use a command line instead of your own library.\n\n\nGather the info that you need\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo update the status of a commit in a Pull Request, you will need to provide\nsome basic information:\n\n1. The name of the GitHub repository which has your Pull Request\n\n2. The commit SHA that is to be updated (e.g., the last commit in a pull\n request)\n\n3. The desired status of the commit:\n - \"success\" (GitHub displays a green checkmark)\n - \"pending\" (GitHub displays a yellow circle)\n - \"error\" or \"failure\" (GitHub displays a red 'X')\n\n4. Description (e.g., \"You know you can change this, right?\" was the description\n used in the example above)\n\n5. Authorization token. This will allow the command to act like you.\n Instructions on how to create this token follow.\n\n\nPersonal Access Token\n^^^^^^^^^^^^^^^^^^^^^\n\nThis tool is intended to change the status of a GitHub Pull Request. That is\nsomething that should only be allowed by someone who is authorized. You\nwouldn't want someone that you hadn't authorized updating your Pull Request\nstatuses.\n\nYou will need to generate a Personal Access Token so that this command line can\nact like you. Keep this token safe -- it is like a password.\n\nThis is done in your account settings configuration. Don't confuse the\nproject's settings with your settings for your account.\n\n\nProfile Settings\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIn the upper right hand corner, you will see your avatar photo (or a default\navatar image). When you click the avatar, there will be a drop down menu with\nmenu options. Choose the **Settings** option.\n\n`Upper Right Hand Corner Menu `_\n\n\nDeveloper Settings\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nOn the next page that is loaded, the Profile settings page, you will see another\nmenu to the left. It is a longer menu where the bottom looks similar to the\nfollowing. Choose **Developer settings**:\n\n`Developer Settings Menu `_\n\n\nCreate a Personal Access Token\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\nOn the next page, the Developer Settings page, you will see one final menu.\nChoose **Personal access tokens**:\n\n`Personal Access Token Menu `_\n\n\n1. Press the button to **Generate new token**.\n\n2. In the **Token description** enter \"github_commit_status\". This way we\n remember the purpose of this token.\n\n3. Select the **repo:status** scope checkbox. Anyone who has this token could\n update your GitHub account. So, keep the scope of this token so that it can\n **only** update or access the commit status.\n\n `New Token Screenshot `_\n\n4. Scroll to the bottom of click the green **Generate token** button.\n\n5. Your token should now be displayed. This token will only display this time.\n You won't be able to see it again and it cannot be recovered.\n\n6. Keep your token safe so that you can use it with this program. Remember, if\n someone else can access this token, they can update your GitHub statuses -\n even if you don't want them to.\n\n\nExample: Prompt mode\n--------------------\n\nIf you only need to use this comand line rarely, there's no need to worry about\ngetting the command line arguments correct - you will be prompted for any\nrequired arguments that are missing. This is ideal for students in my class who\nonly need to update a Pull Requests a few times for a homework assignment. See\nthe next section for a more scriptable mode and example.\n\n\n1. Install::\n\n pip install github_commit_status\n\n2. Run::\n\n github_commit_status prompt\n\n3. Enter the data that you have collected (e.g., Personal Access Token, commit\n SHA, etc.)\n\n Here is an example that I used for one of my projects. Remember, don't let\n your Personal Access Token get published like I intentionally did here. I\n ensured this token was deleted before I published this::\n\n $ github_commit_status prompt\n\n GitHub Token [26fee6a5d440111a2648312d458b6b4e44c20c1d]:\n Name of the GitHub repository []: my_target_repo\n Commit SHA []: 2dd5f9ce1108d69e863444ee6486e64e0299868f\n Status: pending\n Description: Tests have started\n\n GitHub has been updated.\n\n\nExample: For scripting\n----------------------\n\nThis command can also be used for shell scripts that need to update GitHub.\n\nFor security reasons, this mode/subcommand does not provide an option for::\n\n --github-token\n\nas this is preserved in most shell histories. Instead, the\nenvironment variable *GITHUB_COMMIT_STATUS_TOKEN* should already be set. For\nexample, in a bash shell::\n\n export GITHUB_COMMIT_STATUS_TOKEN=26fee6a5d440111a2648312d458b6...\n\n\n1. Install::\n\n pip install github_commit_status\n\n2. To see command line options that can be provided::\n\n $ github_commit_status update --help\n Usage: github_commit_status update [OPTIONS]\n\n If all options are provided, update GitHub\n\n Options:\n --repo TEXT Name of the GitHub repository [required]\n --commit TEXT The 40 character SHA1 string for the commit.\n [required]\n --status [error|failure|pending|success]\n The status of the commit [required]\n --description TEXT Description for the test [required]\n --help Show this message and exit.\n\n3. Here is an example usage. Remember, your Personal Access Token\n needs to be pre-set in environment variable **GITHUB_COMMIT_STATUS_TOKEN**::\n\n $ github_commit_status update --repo=my_target_repo \\\n --commit=\"2dd5f9ce1108d69e863444ee6486e64e0299868f\" \\\n --status=pending \\\n --description=\"Tests are running.\"\n\n\nMake this better by Contributing\n--------------------------------\n\nThis is an Open Source project and contributions are always welcome, and they\nare greatly appreciated! Every little bit helps, and credit will always be\ngiven.\n\nYou can contribute in many ways:\n\n* `Report bugs `__\n* `Write Documentation `__\n* `Fix bugs `__\n\nTo maximize the chance that your hard work gets merged, we have these guidelines\nto guide you along the way to a successfully merged Pull Request:\n\n* :ref:`contribution_link`\n* https://github.com/glenjarvis/github_commit_status/blob/master/CONTRIBUTING.rst\n\n\n",
"description_content_type": "text/x-rst",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/glenjarvis/github_commit_status",
"keywords": "github_commit_status",
"license": "MIT license",
"maintainer": "",
"maintainer_email": "",
"name": "github-commit-status",
"package_url": "https://pypi.org/project/github-commit-status/",
"platform": "",
"project_url": "https://pypi.org/project/github-commit-status/",
"project_urls": {
"Homepage": "https://github.com/glenjarvis/github_commit_status"
},
"release_url": "https://pypi.org/project/github-commit-status/1.1.0/",
"requires_dist": [
"Click (>=6.0)",
"pygithub"
],
"requires_python": "",
"summary": "A simple command line for updating a commit's status on GitHub",
"version": "1.1.0"
},
"last_serial": 3922769,
"releases": {
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "85e81532a537d187f6c6d07550728fcc",
"sha256": "4e99f4483b9783813753870b1770764601733f7c33a31b0ff0a0eb8917c43d2a"
},
"downloads": -1,
"filename": "github_commit_status-0.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "85e81532a537d187f6c6d07550728fcc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5992,
"upload_time": "2018-05-31T02:58:08",
"url": "https://files.pythonhosted.org/packages/8b/5a/de52811a954ca4ff0f3e116ebded84762ae66d294c5028f28c374847e716/github_commit_status-0.0.3-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "eb3185cc0e18e8f59912f09c4b20a7c3",
"sha256": "c8c3cbf3da0cd7998d5937cca86d3bc5222aba31124bb15a386eb8526709ff3d"
},
"downloads": -1,
"filename": "github_commit_status-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "eb3185cc0e18e8f59912f09c4b20a7c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17849,
"upload_time": "2018-05-31T02:55:06",
"url": "https://files.pythonhosted.org/packages/b9/6e/ba9db66af20e2b2119061e59919dca72b640247e493cfde5f84202b7c8ca/github_commit_status-0.0.3.tar.gz"
}
],
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "f73e2313b064858ec5cc89ff38bee240",
"sha256": "16b7aa499e5b5fb416273951af8483bf3f944ab40a48b2a8c150644bb1183f7c"
},
"downloads": -1,
"filename": "github_commit_status-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f73e2313b064858ec5cc89ff38bee240",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6029,
"upload_time": "2018-05-31T03:11:44",
"url": "https://files.pythonhosted.org/packages/0c/86/3bc3347019b699ad404040e7074ebfafe5ae4de8e6ad2eb8fe1dd028bb22/github_commit_status-1.0.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a1ee81f487939e94f07d251c894d1e57",
"sha256": "a84af7d0907fa4c91987017fb291c00d1349fd0efe02dde7b1dd437a37a1f7ec"
},
"downloads": -1,
"filename": "github_commit_status-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a1ee81f487939e94f07d251c894d1e57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17925,
"upload_time": "2018-05-31T03:11:45",
"url": "https://files.pythonhosted.org/packages/ad/3e/00f7c57cd87323dfb6a177b0d5f4a5f2a7eaf9e1efc31d159f3cb61a0be9/github_commit_status-1.0.0.tar.gz"
}
],
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "6d80793f1bbe72b942a5c016dbca1a9b",
"sha256": "750ce354775578a4e3ce64a54fc9a2c5604d4f069e67ef8a50df3c1bb228ba9d"
},
"downloads": -1,
"filename": "github_commit_status-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d80793f1bbe72b942a5c016dbca1a9b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5808,
"upload_time": "2018-05-31T20:37:44",
"url": "https://files.pythonhosted.org/packages/a6/11/a7f472447b3e8dc1b669bed317a75dae4ca844ac366164bbfae4ef4cab2b/github_commit_status-1.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "401b1b015a40656455cbfd73de7fd5b7",
"sha256": "1273a19ef4ab414abf4e6134d588a79f224bf2dadb1aa300157b9eaa298b0432"
},
"downloads": -1,
"filename": "github_commit_status-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "401b1b015a40656455cbfd73de7fd5b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17697,
"upload_time": "2018-05-31T20:37:46",
"url": "https://files.pythonhosted.org/packages/d2/31/f3190e0b6095716de3483e4c2f9da36c8e9247776163a28a0d36478241b9/github_commit_status-1.0.1.tar.gz"
}
],
"1.0.3": [
{
"comment_text": "",
"digests": {
"md5": "cb094f8a4f82afa85b1619f2f1c0873c",
"sha256": "7d65734d14ce5ddce2d5ce8febcced57dd5561a41fc064bb2332267cfc692a0a"
},
"downloads": -1,
"filename": "github_commit_status-1.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb094f8a4f82afa85b1619f2f1c0873c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6908,
"upload_time": "2018-06-01T05:07:20",
"url": "https://files.pythonhosted.org/packages/28/4e/2af3f3e7363b6d07e63366426ab00ad7d2ca2b0807c35c8736625adc67e3/github_commit_status-1.0.3-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a1ac3ed69fd9f9ff4ff1150d0433da64",
"sha256": "5ed150e1c4e86d0e1ec1e73be156213f41d879550edeb52aefc1a4072560d43c"
},
"downloads": -1,
"filename": "github_commit_status-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "a1ac3ed69fd9f9ff4ff1150d0433da64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 540669,
"upload_time": "2018-06-01T05:07:22",
"url": "https://files.pythonhosted.org/packages/4a/01/cdb1f472bdc0597b9723a32186e63bf5ed34ec536f1095a8047a85d3189d/github_commit_status-1.0.3.tar.gz"
}
],
"1.1.0": [
{
"comment_text": "",
"digests": {
"md5": "86eb1674b8dcc96808c765ef42e61390",
"sha256": "ceb02c7865062a9606a0346949e2c1909a3ab44b5f1a039da0bf28cbada815fa"
},
"downloads": -1,
"filename": "github_commit_status-1.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "86eb1674b8dcc96808c765ef42e61390",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7440,
"upload_time": "2018-06-02T03:49:09",
"url": "https://files.pythonhosted.org/packages/32/82/6ad76084302bbec6c68205449c9ac74c1ec9be9e277a7c84f08de89cf57b/github_commit_status-1.1.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "682a73a0a5520de6cb5307b8ecad0a68",
"sha256": "62448aac9ff0d9088304c5e28cff5cb9729c62bd8405679986b9fe02351616c7"
},
"downloads": -1,
"filename": "github_commit_status-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "682a73a0a5520de6cb5307b8ecad0a68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 540905,
"upload_time": "2018-06-02T03:49:10",
"url": "https://files.pythonhosted.org/packages/24/25/2372b6836fc340406d4afcc6a11c58a6de0b0edcf1d24a7c47ea30c12800/github_commit_status-1.1.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "86eb1674b8dcc96808c765ef42e61390",
"sha256": "ceb02c7865062a9606a0346949e2c1909a3ab44b5f1a039da0bf28cbada815fa"
},
"downloads": -1,
"filename": "github_commit_status-1.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "86eb1674b8dcc96808c765ef42e61390",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7440,
"upload_time": "2018-06-02T03:49:09",
"url": "https://files.pythonhosted.org/packages/32/82/6ad76084302bbec6c68205449c9ac74c1ec9be9e277a7c84f08de89cf57b/github_commit_status-1.1.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "682a73a0a5520de6cb5307b8ecad0a68",
"sha256": "62448aac9ff0d9088304c5e28cff5cb9729c62bd8405679986b9fe02351616c7"
},
"downloads": -1,
"filename": "github_commit_status-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "682a73a0a5520de6cb5307b8ecad0a68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 540905,
"upload_time": "2018-06-02T03:49:10",
"url": "https://files.pythonhosted.org/packages/24/25/2372b6836fc340406d4afcc6a11c58a6de0b0edcf1d24a7c47ea30c12800/github_commit_status-1.1.0.tar.gz"
}
]
}