Metadata-Version: 2.1
Name: octopype
Version: 0.1.0
Summary: GitHub API Wrapper written in Python.
Home-page: https://github.com/BLUEAMETHYST-Studios/octopype
Author: BLUEAMETHYST-Studios
Maintainer: BLUEAMETHYST-Studios
Keywords: github,api,wrapper,http
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Description-Content-Type: text/markdown
License-File: LICENSE

# 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).
