[Bootcamp Mini Project] Github Analytics Project

Directory Structure

.
├── app
│   ├── listeners
│   │   ├── __init__.py
│   │   ├── base.py
│   │   ├── cached_session.py
│   │   ├── client_session.py
│   │   └── redis.py
│   ├── managers
│   │   ├── __init__.py
│   │   ├── bitbucket_manager.py
│   │   ├── github_manager.py
│   │   ├── repo_manager.py
│   │   ├── request_manager.py
│   │   └── user_manager.py
│   ├── models
│   │   ├── __init__.py
│   │   ├── repos.py
│   │   └── users.py
│   ├── routes
│   │   ├── __init__.py
│   │   ├── api.py
│   │   ├── main.py
│   │   ├── repos.py
│   │   └── users.py
│   ├── __init__.py
│   ├── cache.py
│   ├── config.py
│   ├── exceptions.py
│   ├── middlewares.py
│   └── server.py
├── templates/
├── README.md
├── requirements.txt
└── start.sh

Screenshots

Setup for local dev

Build

py -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Redis Installation

brew install redis

Run

# start redis server
$ redis-server

# check if redis is up and on proper address
$ redis-cli
host:port> ping
PONG

# start sanic server
sanic app.server:create_app --dev

Now go to, localhost:8000/docs to get info on various available routes

Local Demos

Docs

OpenAPI Swagger http://127.0.0.1:8000/docs/

User demo

Google | Github http://127.0.0.1:8000/user/google

Twitter | Github http://127.0.0.1:8000/user/twitter

Miguel Grinberg | Github http://localhost:8000/user/miguelgrinberg

Andrej | Github http://localhost:8000/user/karpathy

Compare

Compare User http://127.0.0.1:8000/user/compare?user1=google&user2=twitter

Compare User http://127.0.0.1:8000/user/compare?user1=miguelgrinberg&user2=karpathy

Repo demo

google/leveldb | Github http://127.0.0.1:8000/repo/google/leveldb

pallets/flask | Github http://localhost:8000/repo/pallets/flask

sanic-org/sanic | Github http://localhost:8000/repo/sanic-org/sanic

aio-libs/aiohttp | Github http://localhost:8000/repo/aio-libs/aiohttp

Compare

google/leveldb vs facebook/rocksdb http://localhost:8000/repo/compare?user1=google&repo1=leveldb&user2=facebook&repo2=rocksdb

sanic-org/sanic vs pallets/flask http://localhost:8000/repo/compare?user1=sanic-org&repo1=sanic&user2=pallets&repo2=flask

TODO

• Logging
• Refactoring to OOP
• Tests
• Configuration
• Docker
• ORM/DB support
• Manager Refactor

Misc

Generate Directory Tree

tree --gitignore -o tree --dirsfirst -n