# Octopype
## What is Octopype?
Octopype is a Wrapper for the [GitHub API](https://docs.github.com/rest) written in Python using the [requests](https://pypi.org/project/requests) library. \
The focus is on making it simple for the user and filling every niche with the features, that the GitHub API offers.
## Disclaimer
Octopype is still in Early Development and it does not have many features yet!
## Installing
```
pip install octopype
```
## Basic tutorials
### 1. Getting your Github bio.
```python
import octopype
github = octopype.OctoPype("INSERT TOKEN HERE")
print("My GitHub Bio is: " + github.account.info().bio)
```
### 2. Getting the name of a repository owner
```python
import octopype
github = octopype.OctoPype("INSERT TOKEN HERE")
print("The owner of Octopype's repository is: " + github.repository.getrepository("BLUEAMETHYST-Studios", "octopype").owner.name)
```
### 3. Updating your display name
```python
import octopype
github = octopype.OctoPype("INSERT TOKEN HERE")
github.account.update.display_name("OctoPype") # Will set your display name to 'OctoPype'
```
## License
[Octopype](https://github.com/BLUEAMETHYST-Studios/octopype) by [BLUEAMETHYST-Studios](https://github.com/BLUEAMETHYST-Studios) is licensed under the [GNU GENERAL PUBLIC LICENSE Version 3](https://gnu.org/licenses/gpl-3.0). \
To view the full license, click [here](https://github.com/BLUEAMETHYST-Studios/octopype/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/BLUEAMETHYST-Studios/octopype",
"name": "octopype",
"maintainer": "BLUEAMETHYST-Studios",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "github,api,wrapper,http",
"author": "BLUEAMETHYST-Studios",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b6/36/6a20cd7919eed0f610c7f6d3a82a5533e925f1e5426fab7dbe6ed70d2481/octopype-0.1.0.tar.gz",
"platform": null,
"description": "# Octopype\n\n## What is Octopype?\n\nOctopype is a Wrapper for the [GitHub API](https://docs.github.com/rest) written in Python using the [requests](https://pypi.org/project/requests) library. \\\nThe focus is on making it simple for the user and filling every niche with the features, that the GitHub API offers.\n\n## Disclaimer\n\nOctopype is still in Early Development and it does not have many features yet!\n\n## Installing\n\n```\npip install octopype\n```\n\n## Basic tutorials\n\n### 1. Getting your Github bio.\n\n```python\nimport octopype\n\ngithub = octopype.OctoPype(\"INSERT TOKEN HERE\")\nprint(\"My GitHub Bio is: \" + github.account.info().bio)\n```\n\n### 2. Getting the name of a repository owner\n\n```python\nimport octopype\n\ngithub = octopype.OctoPype(\"INSERT TOKEN HERE\")\nprint(\"The owner of Octopype's repository is: \" + github.repository.getrepository(\"BLUEAMETHYST-Studios\", \"octopype\").owner.name)\n```\n\n### 3. Updating your display name\n\n```python\nimport octopype\n\ngithub = octopype.OctoPype(\"INSERT TOKEN HERE\")\ngithub.account.update.display_name(\"OctoPype\") # Will set your display name to 'OctoPype'\n```\n\n## License\n\n[Octopype](https://github.com/BLUEAMETHYST-Studios/octopype) by [BLUEAMETHYST-Studios](https://github.com/BLUEAMETHYST-Studios) is licensed under the [GNU GENERAL PUBLIC LICENSE Version 3](https://gnu.org/licenses/gpl-3.0). \\\nTo view the full license, click [here](https://github.com/BLUEAMETHYST-Studios/octopype/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "",
"summary": "GitHub API Wrapper written in Python.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/BLUEAMETHYST-Studios/octopype"
},
"split_keywords": [
"github",
"api",
"wrapper",
"http"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc3ed229aa7bf61a0c0f32bef77d0141a4d7a3a7213ad7047c92f0ba8928d1ee",
"md5": "ba73574e990e0e8304289be187b98a57",
"sha256": "2a23b4a10004829fa29fc0e691e171c687f22a53776182f43c4a40c1b7433fcf"
},
"downloads": -1,
"filename": "octopype-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba73574e990e0e8304289be187b98a57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19590,
"upload_time": "2023-08-26T22:50:43",
"upload_time_iso_8601": "2023-08-26T22:50:43.441096Z",
"url": "https://files.pythonhosted.org/packages/fc/3e/d229aa7bf61a0c0f32bef77d0141a4d7a3a7213ad7047c92f0ba8928d1ee/octopype-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b6366a20cd7919eed0f610c7f6d3a82a5533e925f1e5426fab7dbe6ed70d2481",
"md5": "ed850f557dfcfff03c43ad36187deaf7",
"sha256": "d360f6094d88d0d0a3c353a9819d302414a3dd59f422dd522844dc50f70e8e90"
},
"downloads": -1,
"filename": "octopype-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ed850f557dfcfff03c43ad36187deaf7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18440,
"upload_time": "2023-08-26T22:50:45",
"upload_time_iso_8601": "2023-08-26T22:50:45.359200Z",
"url": "https://files.pythonhosted.org/packages/b6/36/6a20cd7919eed0f610c7f6d3a82a5533e925f1e5426fab7dbe6ed70d2481/octopype-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-26 22:50:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BLUEAMETHYST-Studios",
"github_project": "octopype",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "octopype"
}
JSON
