An open API service indexing awesome lists of open source software.

https://github.com/jackdbd/hokuto-no-ken-api

An API built by scraping the Hokuto Renkitōza wiki with Scrapy. Deployed on AWS as a Flask app with Zappa.
https://github.com/jackdbd/hokuto-no-ken-api

api aws-lambda flask scrapy serverless sqlalchemy zappa

Last synced: 4 months ago
JSON representation

An API built by scraping the Hokuto Renkitōza wiki with Scrapy. Deployed on AWS as a Flask app with Zappa.

Awesome Lists containing this project

README

          

# Hokuto no Ken API

[![Build Status](https://travis-ci.org/jackdbd/hokuto-no-ken-api.svg?branch=master)](https://travis-ci.org/jackdbd/hokuto-no-ken-api) [![Code Coverage](https://codecov.io/gh/jackdbd/hokuto-no-ken-api/coverage.svg)](https://codecov.io/gh/jackdbd/hokuto-no-ken-api) [![DeepScan grade](https://deepscan.io/api/teams/3517/projects/8277/branches/95709/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3517&pid=8277&bid=95709) [![GitHub issues](https://img.shields.io/github/issues/jackdbd/hokuto-no-ken-api.svg)](https://github.com/jackdbd/hokuto-no-ken-api/issues/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

:warning: :construction_worker: WORK IN PROGRESS :building_construction: :construction:

## Table of Contents

1. [Hokuto Data](https://github.com/jackdbd/hokuto-no-ken-api/tree/master/hokuto_data)
2. [Hokuto Flask](https://github.com/jackdbd/hokuto-no-ken-api/tree/master/hokuto_flask)
3. [Hokuto Scraping](https://github.com/jackdbd/hokuto-no-ken-api/tree/master/hokuto_scraping)
4. [Hokuto API Reporting](https://github.com/jackdbd/hokuto-no-ken-api/tree/master/hokuto_api_reporting)

Here is the latest [API report](https://hokuto-no-ken-api-report.surge.sh/) from the last Postman collection run.

## Usage

```sh
# From the Hokuto Scraping root directory
pipenv run scrape

# From the Hokuto Data root directory (you must connect to a Redis)
pipenv run dump
```