universities

mirror of https://github.com/ycd/universities.git synced 2026-03-13 09:14:01 +08:00

Go to file

dependabot[bot] 70b847f5a8 Bump fastapi from 0.60.2 to 0.65.2

Bumps [fastapi](https://github.com/tiangolo/fastapi) from 0.60.2 to 0.65.2.
- [Release notes](https://github.com/tiangolo/fastapi/releases)
- [Commits](https://github.com/tiangolo/fastapi/compare/0.60.2...0.65.2)

---
updated-dependencies:
- dependency-name: fastapi
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

2021-06-10 15:48:55 +00:00

app

fix docs

2020-08-14 13:02:18 +03:00

docs

fix docs

2020-08-14 13:02:18 +03:00

.gitignore

add .gitignore

2020-08-09 02:02:34 +03:00

.travis.yml

Rewrite.

2020-08-09 02:27:25 +03:00

app.yaml

version 0.1.0

2020-07-08 14:59:59 +03:00

LICENSE

Initial commit

2020-07-08 13:31:29 +03:00

README.md

Update README.md

2020-08-14 13:04:16 +03:00

requirements.txt

Bump fastapi from 0.60.2 to 0.65.2

2021-06-10 15:48:55 +00:00

README.md

Universities is free & open source API service. 🎒

Features 🚀

Python FastAPI backend. 🔨
SQLAlchemy - models 📊
Asynchronous - Thanks to Uvicorn Universities API comes with a incredibly fast ASGI server, 🚀
Large database - Supports over +140 countries +9600 Universities 📡
Documentation - Have an automatic API documentation web user interface thanks to FastAPI
Open source - Everything from the code base is opensource and free to use under a permissive MIT license.

Try it online with the Documentation now!

How to use & query parameters 💡

You can search by:

Country /search?country=India or /search?country=United+States
Name /search?name=harvard
Alpha_two_code /search?alpha_two_code=FR
Domain /search?domain=uni-muenchen.de

Multiple querying & Auto completion

Name and Country /search?country=Brazil&name=Centro
Name and Alpha_two_code /search?name=oxford&alpha_two_code=gb

Example Response

{
    "name": "Ludwig-Maximilians-Universität München",
    "alpha_two_code": "DE",
    "country": "Germany",
    "web_pages": [
      "http://www.uni-muenchen.de/"
    ],
    "domains": [
      "uni-muenchen.de"
    ],
    "state_province": null
}

For Installation 📌

git clone https://github.com/ycd/universities.git
cd universities
virtulenv env
source env/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload

License

This project is licensed under the terms of the MIT license.