https://github.com/namescode/hub_harvester

A python script to gather data on a user or organisations git repos
https://github.com/namescode/hub_harvester

data github nix nix-flake python python3 sqlite

Last synced: 3 days ago
JSON representation

A python script to gather data on a user or organisations git repos

• Host: GitHub
• URL: https://github.com/namescode/hub_harvester
• Owner: NamesCode
• License: mit
• Created: 2023-10-31T23:41:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-03T00:46:01.000Z (about 1 year ago)
• Last Synced: 2023-11-04T00:29:46.553Z (about 1 year ago)
• Topics: data, github, nix, nix-flake, python, python3, sqlite
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hub harvester 

Gathers data from GitHub about a user or organisation by using the GitHub API to crawl its repositories.

This will be rather slow, so I recommend using an authentication token to help speed it up.

For documentation on how the `SQLite` database is formatted you can find it [here](docs/sqlite.md)

## Usage

- Install the `PyGithub` package: 

```bash

pip install pygithub

```

- Run the script in `src/`: **This will take a while to crawl**

```bash

python src/main.py

```

OR run the following:

```bash

git clone https://github.com/NamesCode/hub_harvester.git

cd hub_harvester

pip install pygithub

python src/main.py

```

### Using Nix

Run the following:

```bash

git clone https://github.com/NamesCode/hub_harvester.git

cd hub_harvester

nix develop

python src/main.py

```