{ "info": { "author": "Peter Bengtsson", "author_email": "mail@peterbe.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: Implementation :: CPython" ], "description": "# git-submodule-updater\n\nA tool to automate making GitHub Pull Requests about updating\ngit submodules.\n\nYou should be able to just give it the name of a repo (e.g. `mozilla/kuma`)\nand it finds out which submodules there are and looks to see if they can be\nupdated.\n\n## Demo\n\nNot really a demo but [this pull request](https://github.com/mdn/stumptown-renderer/pull/62)\nwas entirely made from this script.\n\n## Limitations and caveats\n\nAt the time of writing, **this is a prototype**. It's doing the least possible\nto make the most basic thing work.\n\n- It requires that you're allowed to push branches to the origin.\n- It only really works with GitHub.com\n- It's doing the `git` clone with SSH. So not sure how to make this work in\n a server.\n- It's only a CLI at the moment.\n- There's no good way to auto-close now out-of-date older PRs\n- No unit tests\n- Not tested beyond the defaults of `master` and `origin`\n- It can only make 1 PR per the difference between the head and the submodule.\n- To see what the difference in a submodule update you have to rely on GitHub's\n \"Files changed\" tab on the PR.\n\n## Getting started\n\nYou'll need a GitHub access token.\nGo to [github.com/settings/tokens](https://github.com/settings/tokens) and create a token,\ncopy and paste it into your `.env` file or use `export`. E.g.\n\n cat .env\n GITHUB_ACCESS_TOKEN=a36f6736...\n\n pip install git-submodule-updater\n gsmu github.com/mdn/stumptown-renderer # for example\n\nIf you don't use a `.env` file you can use:\n\n GITHUB_ACCESS_TOKEN=a36f6736... gsmu myorg/myrepo\n\n## Goal\n\nThis tool should be possible to run as a CLI and as a web server\nso it can be connected to a GitHub repo Webhook.\n\n## Contributing\n\nClone this repo then run:\n\n pip install -e \".[dev]\"\n\nThat should have installed the CLI `gsmu`\n\n gsmu --help\n\nIf you wanna make a PR, make sure it's formatted with `black` and passes `flake8`.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/peterbe/git-submodule-updater", "keywords": "git github submodule", "license": "MPL 2.0", "maintainer": "", "maintainer_email": "", "name": "git-submodule-updater", "package_url": "https://pypi.org/project/git-submodule-updater/", "platform": "", "project_url": "https://pypi.org/project/git-submodule-updater/", "project_urls": { "Homepage": "https://github.com/peterbe/git-submodule-updater" }, "release_url": "https://pypi.org/project/git-submodule-updater/0.0.1/", "requires_dist": [ "GitPython", "click", "PyGithub", "python-decouple" ], "requires_python": "", "summary": "Lemme make a PR for you to update that git submodule", "version": "0.0.1" }, "last_serial": 5590504, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "4fea915adb8c90b71a36c64d383de20b", "sha256": "5cb1942722232832b304ea1760631272558bd3e652e63b2e0098c091c0a59efa" }, "downloads": -1, "filename": "git_submodule_updater-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4fea915adb8c90b71a36c64d383de20b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5132, "upload_time": "2019-07-26T19:44:53", "url": "https://files.pythonhosted.org/packages/b2/29/087aa25a2dfa465ad33aeb328c0c481a00aee509afeaf40fa7745670a960/git_submodule_updater-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ef41cf1317f55ba18d58a2dfde06a6b", "sha256": "d87d6b437db7efddfa48192296142f91a3e6ce1686bd06165efeb352f0a9424e" }, "downloads": -1, "filename": "git-submodule-updater-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1ef41cf1317f55ba18d58a2dfde06a6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4565, "upload_time": "2019-07-26T19:44:55", "url": "https://files.pythonhosted.org/packages/ab/98/a8b8cf7dc39487bc7973b57a60d3f6f41df9babcd07a18e05cbcdaf33851/git-submodule-updater-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4fea915adb8c90b71a36c64d383de20b", "sha256": "5cb1942722232832b304ea1760631272558bd3e652e63b2e0098c091c0a59efa" }, "downloads": -1, "filename": "git_submodule_updater-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4fea915adb8c90b71a36c64d383de20b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5132, "upload_time": "2019-07-26T19:44:53", "url": "https://files.pythonhosted.org/packages/b2/29/087aa25a2dfa465ad33aeb328c0c481a00aee509afeaf40fa7745670a960/git_submodule_updater-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ef41cf1317f55ba18d58a2dfde06a6b", "sha256": "d87d6b437db7efddfa48192296142f91a3e6ce1686bd06165efeb352f0a9424e" }, "downloads": -1, "filename": "git-submodule-updater-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1ef41cf1317f55ba18d58a2dfde06a6b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4565, "upload_time": "2019-07-26T19:44:55", "url": "https://files.pythonhosted.org/packages/ab/98/a8b8cf7dc39487bc7973b57a60d3f6f41df9babcd07a18e05cbcdaf33851/git-submodule-updater-0.0.1.tar.gz" } ] }