Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.04 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.04 KB
Raw

oss_stats

oss_stats is a Python CLI tool that fetches statistics from the acmcsufoss GitHub organization and the acmcsuf.com repository, including issues, pull requests, commits, and total number of contributors. It provides an interactive command-line interface with colored outputs to make exploring GitHub data simple and engaging.

Installation

To install oss_stats locally:

pip install .

Alternatively, if you’re actively developing:

pip install -e .

Note: The -e flag installs the project in editable mode so that any changes you make reflect immediately without reinstallation.

Prerequisites

To access GitHub statistics, you’ll need a GitHub personal access token.

How to Get a GitHub Token

  1. Go to GitHub Settings.
  2. Click "Generate new token".
  3. Under "Select scopes", enable the following:
    • repo (to access private and public repositories, if needed)
    • read:org (if you want to access organization-level data)
  4. Click "Generate token" and copy the token (you won’t be able to see it again).

⚠️ Important: Keep this token secret! Treat it like a password.

Setting up the Development Environment

  1. Clone the repository:

    git clone https://github.com/acmcsufoss/oss_stats.git
cd oss_stats

  2. Create a virtual environment (recommended):

    python -m venv venv
source venv/bin/activate  # On macOS/Linux
.\venv\Scripts\activate   # On Windows

  3. Install the required dependencies:

    pip install -r requirements.txt

  4. Set up your GitHub token:

    • Create a .env file in the project root with the following content:
    GITHUB_TOKEN="your_github_token_here"

Usage

Once installed, you can run the CLI tool from the terminal:

oss_stats

Developed with 💚 by acmcsufoss