https://github.com/verovaleros/nuggit

Small bits of insights from GitHub repositories
https://github.com/verovaleros/nuggit

community github indexcard information software

Last synced: about 2 months ago
JSON representation

Small bits of insights from GitHub repositories

• Host: GitHub
• URL: https://github.com/verovaleros/nuggit
• Owner: verovaleros
• License: gpl-2.0
• Created: 2024-10-22T20:41:50.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-10T13:09:04.000Z (3 months ago)
• Last Synced: 2024-12-20T17:09:04.472Z (about 2 months ago)
• Topics: community, github, indexcard, information, software
• Language: Python
• Homepage:
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Nuggit: Small bits of insights from GitHub repositories

Nuggit is a Python tool that creates an index-card like summary of a GitHub repository.



## Installation

Using virtual environments to manage requirements:

```bash

:~$ git clone https://github.com/verovaleros/nuggit.git

:~$ cd nuggit/

:~$ python3 -m venv .venv

:~$ source .venv/bin/activate

:~$ pip install -r requirements.txt

```

## Usage

```python

:~$ python3 nuggit.py --help

usage: nuggit.py [-h] -r REPO [-l LOG_FILE] [-d] [-v]

Nuggit: Small bits of big insights from GitHub repositories

optional arguments:

  -h, --help            show this help message and exit

  -r REPO, --repo REPO  URL of the GitHub repository to analyze.

  -l LOG_FILE, --log_file LOG_FILE

                        Log file name (default: nuggit.log)

  -d, --debug           Extra verbose for debugging.

  -v, --verbose         Be verbose```

```

## About

This tool was created by verovaleros on October 2024. GNU General Public License v2.0.