https://github.com/geekmasher/gh-org-summary

GitHub Organisation Summary
https://github.com/geekmasher/gh-org-summary

Last synced: 13 days ago
JSON representation

GitHub Organisation Summary

• Host: GitHub
• URL: https://github.com/geekmasher/gh-org-summary
• Owner: GeekMasher
• License: mit
• Created: 2023-09-22T16:37:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-11T10:00:04.000Z (10 months ago)
• Last Synced: 2024-01-11T14:34:35.906Z (10 months ago)
• Language: Python
• Size: 56.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


GitHub Organisation Summary


[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GeekMasher/gh-org-summary)

[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/gh-org-summary?style=for-the-badge)](https://github.com/GeekMasher/gh-org-summary/issues)

[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/gh-org-summary?style=for-the-badge)](https://github.com/GeekMasher/gh-org-summary)

[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)



## ⚡️ Requirements

- [Python][python] `>= 3.10`

- [pip][python-pip] `>= 23.x`

  - `pip install ghastoolkit` (`>= 0.10.0`)

- [gh-cli][gh-cli] (optional)

- GitHub Personal Access Token (PAT)

  - Requires access to `org:read`, `repo:read`, and `repo:security_events` scopes

## 📦 Installing

**Using [gh-cli][gh-cli]:**

To install and setup the CLI tool, you can use the following commands:

```bash

# install extension

gh extension install GeekMasher/gh-org-summary

# install deps (ghastoolkit)

gh org-summary install

# run

gh org-summary --help

# update / upgrade extension

gh extension upgrade gh-org-summary

```

**Install Manually:**

```bash

# clone and cd into repo

clone https://github.com/GeekMasher/gh-org-summary.git

cd gh-org-summary

# install deps (ghastoolkit)

pip install ghastoolkit

# run

python ./summary.py --help

```

## 📝 Usage

To generate a summary of your GitHub organisation, you can use the following command:

```bash

gh org-summary \

    --github-instance "https://github.example.com" \

    --output "./output.csv"

```

**Access Token:**

The script automatically looks for the `GITHUB_TOKEN` environment variable but you can also supply the token via the `-t` or `--github-token` argument or it will prompt you.

```bash

gh org-summary \

    --github-instance "https://github.example.com" \

    --output "./output.csv" \

    --github-token "ghp_1234567890"

```

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

[python]: https://www.python.org/

[python-pip]: https://pip.pypa.io/en/stable

[gh-cli]: https://cli.github.com/