Giter VIP home page Giter VIP logo

fastapi-glottolog's Introduction

fastapi-glottolog

License:MIT

REST API for Glottolog using Python FastAPI.

Note: This is a project independent of Glottolog.org.

Installation

python3 -m venv venv

. venv/bin/activate

pip3 install -r requirements.txt

Clone Glottolog into ./app folder:

cd app
git clone https://github.com/glottolog/glottolog

Run for Development

cd app
uvicorn main:app --reload

Try searching by language e.g.:

http://localhost:8000/v1/search/Indonesian

Try searching by Glottolog id:

http://localhost:8000/v1/lang/pera1256

OpenAPI Documentation

Run uvicorn main:app --reload and open http://localhost:8000/docs/

Docker

Create the Docker image with:

docker build -t fastapi-glottolog .

Run with:

docker run -d --name fastapi-glottolog-container -p 80:80 fastapi-glottolog

Log in to Container:

docker exec -it -u root fastapi-glottolog-container /bin/bash

Pre-built Image in Docker Hub:

https://hub.docker.com/r/tderflinger/fastapi-glottolog

Pull Image:

docker pull tderflinger/fastapi-glottolog:0.1.0

Roadmap

  • Return bibliographical information for languages.
  • CLI for API

References

Glottolog: https://glottolog.org/

pyglottolog: https://github.com/glottolog/pyglottolog

FastAPI: https://fastapi.tiangolo.com/

License

Fastapi-glottolog is licensed under the MIT License

The Glottolog data is licensed as CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/

fastapi-glottolog's People

Contributors

tderflinger avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.