Metadata-Version: 2.1
Name: githuby
Version: 0.1.1
Summary: Simple package to get data about GitHub users
Home-page: https://github.com/chr3st5an/githuby
License: MIT
Keywords: github,api,asyncio,async,aiohttp,user
Author: Christian
Author-email: 64144555+chr3st5an@users.noreply.github.com
Requires-Python: >=3.8,<4.0
Classifier: Framework :: aiohttp
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
Project-URL: Bug Tracker, https://github.com/chr3st5an/githuby/issues
Project-URL: Repository, https://github.com/chr3st5an/githuby
Description-Content-Type: text/markdown

<h1 align="center">
    githuby
</h1>

---

Simple package for fetching user data from GitHub. This package provides
one simple async function `fetch_user()`, which wraps the data returned by the
GitHub API into a `User` object which then can be used to easily access
the data. Repositories are also fetched and wrapped up into `Repository`
instances.

## Installing

Python3.8 or above is required.

```sh
pip install githuby
```

## Quick Example

```py
from githuby import fetch_user
import asyncio


async def main():
    user = await fetch_user("chr3st5an")

    print(f"{user.username}#{user.id} has {len(user.repositories)} repos:")

    for repo in user.repositories:
        print(f"{repo.name}@{repo.url}")


asyncio.run(main())
```

... or from the CLI

```sh
python -m githuby chr3st5an
```

