https://github.com/kingsdigitallab/gitan

git analyser (gitan): download metadata from github API, analyse them and return results on a web page.
https://github.com/kingsdigitallab/gitan

code-analysis reusable wip-do-not-use

Last synced: 3 months ago
JSON representation

git analyser (gitan): download metadata from github API, analyse them and return results on a web page.

• Host: GitHub
• URL: https://github.com/kingsdigitallab/gitan
• Owner: kingsdigitallab
• License: mit
• Created: 2019-03-27T20:25:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-01T23:39:55.000Z (about 5 years ago)
• Last Synced: 2024-03-15T04:56:36.417Z (over 2 years ago)
• Topics: code-analysis, reusable, wip-do-not-use
• Language: Python
• Size: 168 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Features

* create a local database of django models found across several github repositories

* web page to browse and search those models with direct link to github source code

![screenshot](https://raw.githubusercontent.com/kingsdigitallab/gitan/master/doc/django-model-explorer.png)

## Requirements

* Python 3

* pipenv

* A personal github access token

## Installation

Open a terminal, clone the repo and change into the repo directory:

```

cp local_settings_template.py local_settings.py

# set you github key in local_settings.py

pipenv sync

```

## Download and process metadata

```

pipenv shell

python gitan.py download

python gitan.py parse

```

## Browse metadata

```

python gitan.py runserver 8080

# point your browser to localhost:8080

# ctrl+C to stop the server

```