Metadata-Version: 2.1
Name: grk
Version: 0.0.1
Summary: a silly tool to query cloud-init repo metadata
License: GPL-2.0-only
Author: Brett Holman
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: gql[requests] (==3.5.0)
Requires-Dist: tabulate (==0.9.0)
Description-Content-Type: text/markdown

# grok

*a silly tool to query Github repository metadata*

## Getting started

### Create a personal access token

Generate a public read-only [personal access token](https://github.com/settings/personal-access-tokens/new). Back up the token somewhere safe, then use it in our configuration in the next step

### Create a configuration `~/.config/grok.tolm`

```bash
cat << EOF > ~/.config/grok.toml
[system]
auth_key = "your key goes here"
default_org = "holmanb"
default_repo = "grok"
default_mode = "all"
EOF
```

Be sure to set your key, default organization, and default repo in the configuration.

### Install grok

```bash
pip install --user grk
```

4. Run grok

```bash
grok
```

