{ "info": { "author": "wqy", "author_email": "qiyingwangwqy@gmail.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python :: 3 :: Only" ], "description": "# githubot\n\n[![Build Status](https://travis-ci.org/WqyJh/githubot.svg?branch=master)](https://travis-ci.org/WqyJh/githubot)\n[![license](https://img.shields.io/badge/LICENCE-MIT-brightgreen.svg)](https://raw.githubusercontent.com/WqyJh/githubot/master/LICENSE)\n\n\nCommand line tool to use Github's API for automation:\n\n- [x] create release with assets\n- [x] upload/download files to github\n- [ ] TODO\n\n## Installation\n\n```bash\npip install githubot\n```\n\n## Usage\n\n### Create release with assets\n\n```bash\nReleases management.\n\nUsage: githubot release --token=TOKEN --repo=REPO\n [--tag=TAG] [--title=TITLE] [--message=MESSAGE]\n [ASSETS...]\n\nOptions:\n --token=TOKEN Github access token.\n -r=REPO --repo=REPO Repo full name like: owner/repo.\n --tag=TAG Tag name for the release. If the tag does not\n exist it will be created on default branch.\n --title=TITLE Title for the release.\n --message=MESSAGE Message for the release.\n -h --help Show this message and exit.\n```\n\nFor example:\n\nCreate a release to repo `WqyJh/test` with assets under the path of `assets/`.\n\n```bash\ngithubot release --token --repo WqyJh/test assets/*\n```\n\nCreate a release and specify `tag`, `title` and `message` for it.\n\n```bash\ngithubot release \\\n--token \\\n--repo WqyJh/test \\\n--tag test_tag \\\n--title \"This is an test title\" \\\n--message \"This release contains xxx\" \\\nassets/*\n```\n\nOnly regular files are supported for the `--assets` option, directories are not supported.\nYou can specify files in the following manner:\n\n```bash\n--assets file1 file2\n--assets path/* # wildcard\n```\n\n### Use github repo as cloud storage\n\n```bash\nFiles management.\n\nUsage: githubot file upload --token=TOKEN --repo=REPO [FILES...]\n githubot file download --token=TOKEN --repo=REPO [FILES...]\n\nOptions:\n --token=TOKEN Github access token.\n -r=REPO --repo=REPO Repo full name like: owner/repo.\n -h --help Show this message and exit.\n```\n\n#### Upload files\n\nUpload files to github repo `WqyJh/test`.\n\n```bash\n./run.py file upload \\\n--token \\\n--repo WqyJh/test \\\nfile1 file2 file*\n```\n\n**Note** that the `FILES` argument is just the same with `ASSETS`, only regular files are supported.\n\n\n#### Download files\n\nDownload files from github repo `WqyJh/test`.\n\n```bash\n./run.py file download \\\n--token \\\n--repo WqyJh/test \\\nfile1 dir1 dir2/\n```\n\n**Note** that the `FILES` argument here cannot contains wildcard, but it can contains directories.\n\n\n#### Delete files\n\nDelete files from github repo.\n\n```bash\n./run.py file delete \\\n--token \\\n--repo Wqyjh/test \\\nfile1 dir1 dir2/\n```\n\n\n## Development\n\n- bumping 0.3.0 (PYPI)\n- auto-changelog 1.15.0 (NPM)\n\nThe release processing is as follow:\n\n1. Calculate semantic version\n ```bash\n git checkout dev\n git pull origin dev\n bumping\n ```\n2. Create release branch from dev\n ```bash\n git checkout -b release-\n ```\n3. Modify the version and commit\n4. Generate changelog and commit\n ```bash\n auto-changelog --latest-version --tag-prefix v\n ```\n5. Merge to master branch\n6. Tag version to master branch\n\n### Changelog\n\nAll notable changes to this project will be documented in this file. Dates are displayed in UTC.\n\nGenerated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).\n\n#### [0.6.1](https://github.com/WqyJh/githubot/compare/v0.6.0...v0.6.1)\n\n> 21 August 2019\n\n- fix: fix cli [`c66043a`](https://github.com/WqyJh/githubot/commit/c66043aa0450b7a62e9e4a82086cefd3058412c6)\n- Bump version to 0.6.1 [`bfa3d06`](https://github.com/WqyJh/githubot/commit/bfa3d062db77fe30574fa6bd20151c12157c6488)\n\n#### [0.6.0](https://github.com/WqyJh/githubot/compare/v0.4.0...v0.6.0)\n\n> 21 August 2019\n\n- Release 0.6.0 [`#10`](https://github.com/WqyJh/githubot/pull/10)\n- docs: update README.md [`#9`](https://github.com/WqyJh/githubot/pull/9)\n- feat: add file delete [`#8`](https://github.com/WqyJh/githubot/pull/8)\n- feat: add directory downloading [`#7`](https://github.com/WqyJh/githubot/pull/7)\n- docs: update README.md [`#4`](https://github.com/WqyJh/githubot/pull/4)\n- docs: update CHANGELOG.md [`e6c15a5`](https://github.com/WqyJh/githubot/commit/e6c15a5a9b10526f5ee9dcd643fd09db2f9b94b5)\n- Bump version to 0.6.0 [`7156b94`](https://github.com/WqyJh/githubot/commit/7156b94f214c33791f42480e431178ca7a09a162)\n- Resolve conflicts [`c794221`](https://github.com/WqyJh/githubot/commit/c794221bd74c70a7beff5b430b1c4f45680f2d07)\n\n#### 0.4.0\n\n> 20 August 2019\n\n- Release 0.4.0 [`#2`](https://github.com/WqyJh/githubot/pull/2)\n- Storage [`#1`](https://github.com/WqyJh/githubot/pull/1)\n- feat: add release creation with assets uploading [`28c5214`](https://github.com/WqyJh/githubot/commit/28c52147fc591bebb6bdf4d9da1599605a0cd876)\n- feat: replace click with docopt [`9a7acd9`](https://github.com/WqyJh/githubot/commit/9a7acd98baaab0afd8a321886c7305be5943c6ef)\n- chore: add setup configurations [`2cc899f`](https://github.com/WqyJh/githubot/commit/2cc899fd1d1159a56188fde21d3d8f08042bb604)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/WqyJh/githubot", "keywords": "github,ci", "license": "", "maintainer": "", "maintainer_email": "", "name": "githubot", "package_url": "https://pypi.org/project/githubot/", "platform": "", "project_url": "https://pypi.org/project/githubot/", "project_urls": { "Homepage": "https://github.com/WqyJh/githubot" }, "release_url": "https://pypi.org/project/githubot/0.6.1/", "requires_dist": [ "pygithub", "docopt" ], "requires_python": "", "summary": "Command line tool to use Github API to automate some works.", "version": "0.6.1" }, "last_serial": 5707485, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "7c985e9dd9b14071e9cce8d4def91331", "sha256": "cff6155524be03cf97820d64edc682a3c25755ab9d68a754504170cdded0e625" }, "downloads": -1, "filename": "githubot-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7c985e9dd9b14071e9cce8d4def91331", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3673, "upload_time": "2019-08-20T10:56:52", "url": "https://files.pythonhosted.org/packages/d1/71/5af20eb7fafc67dfbe4a419e2b97e0a48c11be3e18f5fd487831b9669b95/githubot-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6f9c1efc609fa5416d86019c0e37cdb5", "sha256": "5e63ecaa188e37d4a6b1225c1cbd42d1043bf2409f3230a48b0cb2f162cd9342" }, "downloads": -1, "filename": "githubot-0.1.0.tar.gz", "has_sig": false, "md5_digest": "6f9c1efc609fa5416d86019c0e37cdb5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2406, "upload_time": "2019-08-20T10:56:54", "url": "https://files.pythonhosted.org/packages/9b/1c/97d7800c7a816c2778d5faf34c4235f8a1cf2930957c757c0f7276592be7/githubot-0.1.0.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "2b5bae393b4230f007d6f9db6024b14a", "sha256": "d9bfee810dd64a0bac9a2febe333b0ed7608bbc9efec11c0036ddd743c000525" }, "downloads": -1, "filename": "githubot-0.6.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2b5bae393b4230f007d6f9db6024b14a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6655, "upload_time": "2019-08-21T07:11:50", "url": "https://files.pythonhosted.org/packages/93/67/115e8d503c697f4fcc0a924b1717936b9f3a47ff847daf2686f6512b7296/githubot-0.6.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "31136eb429dab110c7ea5583f487022b", "sha256": "a6333378068f1436e5b52738bebcdef54d0f911cc9acf6cb82d3ed727f1fc4cb" }, "downloads": -1, "filename": "githubot-0.6.1.tar.gz", "has_sig": false, "md5_digest": "31136eb429dab110c7ea5583f487022b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4744, "upload_time": "2019-08-21T07:11:52", "url": "https://files.pythonhosted.org/packages/b3/c5/bcc83e7b0d72ccc26000daf3cd7eb464d5ea8a09a122e042fae6fc566a9c/githubot-0.6.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2b5bae393b4230f007d6f9db6024b14a", "sha256": "d9bfee810dd64a0bac9a2febe333b0ed7608bbc9efec11c0036ddd743c000525" }, "downloads": -1, "filename": "githubot-0.6.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2b5bae393b4230f007d6f9db6024b14a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6655, "upload_time": "2019-08-21T07:11:50", "url": "https://files.pythonhosted.org/packages/93/67/115e8d503c697f4fcc0a924b1717936b9f3a47ff847daf2686f6512b7296/githubot-0.6.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "31136eb429dab110c7ea5583f487022b", "sha256": "a6333378068f1436e5b52738bebcdef54d0f911cc9acf6cb82d3ed727f1fc4cb" }, "downloads": -1, "filename": "githubot-0.6.1.tar.gz", "has_sig": false, "md5_digest": "31136eb429dab110c7ea5583f487022b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4744, "upload_time": "2019-08-21T07:11:52", "url": "https://files.pythonhosted.org/packages/b3/c5/bcc83e7b0d72ccc26000daf3cd7eb464d5ea8a09a122e042fae6fc566a9c/githubot-0.6.1.tar.gz" } ] }