{ "info": { "author": "stepik.org", "author_email": "ivan.magda@stepik.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Software Development :: Build Tools" ], "description": "# Upsource API\n\nA Python client library for accessing [Upsource APIs](https://upsource.jetbrains.com/~api_doc/index.html). These client library are not complete and are in developing mode.\n\n### Index\n\n1. [Install](#install)\n2. [Usage](#usage)\n3. [Publish package](#publish-package)\n\n## Install\n\nYou can run Upsource API through Docker:\n```bash\ndocker run -it --rm vanyaland/upsourceapi --help\n```\nBuild by your own:\n```bash\ndocker build -t upsourceapi .\ndocker run -it --rm upsourceapi --help\n```\n\nor install it using the [Python package manager](https://github.com/pypa/pip):\n\n```bash\npip install .\n```\n\n## Usage\n\n### Command line usage\n\nIn this section we cover in detail each of the commands implemented in upsourceapi.\n\n```bash\nupsourceapi --help\n```\n\n### Commands\n\n- [Get all projects](#get-all-projects) - returns the list of all short project infos.\n- [Create project](#create-a-project) - creates a project.\n- [Find projects](#find-projects) - returns the list of projects matching a given search criteria.\n\n#### Get all projects\n\nWith this command you can the list of all short project infos.\n\n- `--base-url`: Base URL of the Upsource API.\n- `--auth-token`: Upsource authorization token, provide it to see private projects. `optional`\n\nExample:\n\n```bash\nupsourceapi get-all-projects \\\n --base-url \"https://example.com/~rpc\" \\\n --auth-token \"AUTH_TOKEN\"\n```\n\n#### Create a project\n\nYou **must** have configured your SSH previously.\n\nWith this command you can create upsource project.\n\n- `--base-url`: Base URL of the Upsource API.\n- `--auth-token`: Upsource authorization token. To see private projects.\n- `--project-name`: Name for the new Upsource project.\n- `--project-url`: The URL to the repo, e.g. ssh://git@example.com/example-repo.git.\n- `--ssh-key`: Private SSH key in OpenSSH format.\n- `--ssh-key-passphrase`: SSH key passphrase.\n- `--sync-token`: Anonymous access to the GitLab/GitHub API is forbidden. Please provide an OAuth 2.0 token (recommended) or a personal access token, which we'll use to read data from GitLab/GitHub. Write requests will be performed on behalf of each individual Upsource user.\n\nExample:\n\n```bash\nupsourceapi create-project \\\n --auth-token \"AUTH_TOKEN\" \\\n --base-url \"https://example.com/~rpc\" \\\n --project-name \"example-project\" \\\n --project-url \"ssh://git@example.com/example-project.git\" \\\n --ssh-key \"$(cat ~/.ssh/id_rsa)\" \\\n --ssh-key-passphrase \"ssh-key-passphrase\" \\\n --sync-token \"OAuth 2.0 token\"\n```\n\n#### Find projects\n\nWith this command you can get the list of projects matching a given search criteria.\n\n- `--base-url`: Base URL of the Upsource API.\n- `--auth-token`: Upsource authorization token, provide it to see private projects. `optional`\n- `--pattern`: Search query, e.g. part of the name.\n- `--limit`: Number of projects to return.\n\nExample:\n\n```bash\ndocker run -it --rm upsourceapi find-projects \\\n --base-url \"https://example.com/~rpc\" \\\n --auth-token \"AUTH_TOKEN\" \\\n --pattern \"query\" \\\n --limit 10\n```\n\n## Publish package\n\nCreate a source distribution with the following command:\n```bash\npython3 setup.py sdist\n```\nStart upload process:\n```bash\ntwine upload dist/*\n```\nor\n```bash\npython3 -m twine upload dist/*\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/bioinf/alt-code", "keywords": "upsource,api", "license": "", "maintainer": "", "maintainer_email": "", "name": "upsourceapi", "package_url": "https://pypi.org/project/upsourceapi/", "platform": "", "project_url": "https://pypi.org/project/upsourceapi/", "project_urls": { "Homepage": "https://github.com/bioinf/alt-code" }, "release_url": "https://pypi.org/project/upsourceapi/0.1.4/", "requires_dist": null, "requires_python": ">=3.0, <4", "summary": "Upsource API", "version": "0.1.4" }, "last_serial": 5267645, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "03d9ab70b68e2331d63512e25b96b529", "sha256": "e1d7c3139f816b7a7e2f7d80acd540ad370937a7ec8bf1cabd4619a607e5425d" }, "downloads": -1, "filename": "upsourceapi-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "03d9ab70b68e2331d63512e25b96b529", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.0, <4", "size": 22304, "upload_time": "2019-04-24T14:38:48", "url": "https://files.pythonhosted.org/packages/da/76/5c0f9020907530697b8166d7a058a6db727ced1e4baa32b902a71639a419/upsourceapi-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ee0a24366de3b793276779a1a445427e", "sha256": "d491192f2ddf113badd0ad24962938f99db70299889a7f46a9f5f67f50ac28cc" }, "downloads": -1, "filename": "upsourceapi-0.1.tar.gz", "has_sig": false, "md5_digest": "ee0a24366de3b793276779a1a445427e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 13682, "upload_time": "2019-04-24T14:38:50", "url": "https://files.pythonhosted.org/packages/b1/b6/d63fd24a85c9f898a234b45a12b0e553b0ed4a18d1318db809ff1b2c3ec0/upsourceapi-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "bcca292ad9eda450a692b7904db28302", "sha256": "1b212ea576bf241f47c49cd32609b5bc2727bb412ebf4ef3749602030ba543c5" }, "downloads": -1, "filename": "upsourceapi-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bcca292ad9eda450a692b7904db28302", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.0, <4", "size": 22340, "upload_time": "2019-04-24T17:14:22", "url": "https://files.pythonhosted.org/packages/be/af/f7a9e9de70e7ab3676c9ee4ca09b2bfdea762a9c72bf29ef5d63a3f1d5f1/upsourceapi-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5487c494d040de5a15a50fb93364d4ec", "sha256": "7339337bf0d2b08378b994f51e9dc653afd8c030f9fe23de28bc52d1348ae05e" }, "downloads": -1, "filename": "upsourceapi-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5487c494d040de5a15a50fb93364d4ec", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 13705, "upload_time": "2019-04-24T17:14:24", "url": "https://files.pythonhosted.org/packages/8b/b4/b6b11c08036a1e99bfd81f09bb3ad68be2d18b86911c6102754e0e6aca65/upsourceapi-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "172a737c8294979b361f23e316814124", "sha256": "f3203e025ec3a104173cd77993740499393bebdfbc1e89240427932b8949a3ca" }, "downloads": -1, "filename": "upsourceapi-0.1.2.tar.gz", "has_sig": false, "md5_digest": "172a737c8294979b361f23e316814124", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 14297, "upload_time": "2019-05-14T11:12:49", "url": "https://files.pythonhosted.org/packages/63/cd/e35cd568c3eee51f739658cbe65f41b83e60f494185784aeb3ec87abbab5/upsourceapi-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "6bddafdacadc66b7c6dedd201a7530ce", "sha256": "94d9e5551e5ea7737cfc974a08d4b1068db61357742f951bc89697a060b60c98" }, "downloads": -1, "filename": "upsourceapi-0.1.3.tar.gz", "has_sig": false, "md5_digest": "6bddafdacadc66b7c6dedd201a7530ce", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 14579, "upload_time": "2019-05-14T13:00:57", "url": "https://files.pythonhosted.org/packages/77/18/01a31bb3b15a440d01002e05bd24b2ba8fdf6bc3224d265651068792e9d8/upsourceapi-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "f00f4eff0968115c7575b205673d4836", "sha256": "0af2bccc001254e876934a42a2caeb6c74b36da032b9e622c7dfab6a0be6e715" }, "downloads": -1, "filename": "upsourceapi-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f00f4eff0968115c7575b205673d4836", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 14620, "upload_time": "2019-05-14T14:15:50", "url": "https://files.pythonhosted.org/packages/68/b2/0df835f697e4b10ab43a82f3259c7da2315e0c62e35345cf44843211a278/upsourceapi-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f00f4eff0968115c7575b205673d4836", "sha256": "0af2bccc001254e876934a42a2caeb6c74b36da032b9e622c7dfab6a0be6e715" }, "downloads": -1, "filename": "upsourceapi-0.1.4.tar.gz", "has_sig": false, "md5_digest": "f00f4eff0968115c7575b205673d4836", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.0, <4", "size": 14620, "upload_time": "2019-05-14T14:15:50", "url": "https://files.pythonhosted.org/packages/68/b2/0df835f697e4b10ab43a82f3259c7da2315e0c62e35345cf44843211a278/upsourceapi-0.1.4.tar.gz" } ] }