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 (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-28T14:21:17.000Z (over 1 year ago)
- Last Synced: 2025-04-06T04:51:27.653Z (about 1 year ago)
- Topics: community, github, indexcard, information, software
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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
:~$ cp nuggit/.env_EXAMPLE nuggit/.env
:~$ #edit the .env file to add your GH token
```
## Usage
```python
:~$ python3 nuggit/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```
```
### Docker
Run nuggit via Docker with:
```bash
:~$ docker run -ti -v $(pwd)/nuggit/.env:/nuggit/.env:ro -v $(pwd)/nuggit/output:/nuggit/output/ -v $(pwd)/nuggit/logs:/nuggit/logs ghcr.io/verovaleros/nuggit:latest python3 nuggit.py -r https://github.com/verovaleros/nuggit
```
## About
This tool was created by verovaleros on October 2024. GNU General Public License v2.0.