https://github.com/iwpnd/toponym-api
API to generate toponyms from input words
https://github.com/iwpnd/toponym-api
aws-lambda fastapi toponym toponym-api
Last synced: 6 months ago
JSON representation
API to generate toponyms from input words
- Host: GitHub
- URL: https://github.com/iwpnd/toponym-api
- Owner: iwpnd
- License: mit
- Created: 2019-11-16T10:59:59.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-13T07:53:40.000Z (over 5 years ago)
- Last Synced: 2025-04-02T13:04:32.548Z (6 months ago)
- Topics: aws-lambda, fastapi, toponym, toponym-api
- Language: Jupyter Notebook
- Homepage:
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Toponym-API
API for [Toponym](https://github.com/iwpnd/toponym) built with the amazing [FastAPI](https://fastapi.tiangolo.com).
# Description
In slavic languages a word can change, depending on how and where it is used within a sentence. The city Moscow (`Москва`) changes to `Москве` when used prepositional. See [toponym](https://github.com/iwpnd/toponym).
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Installing
```
git clone https://github.com/iwpnd/toponym-api.git
```
```
docker build -t toponym_api .
docker run -d --name toponym-api-container -p 80:80 toponym_api
```
## Running the tests
```
git clone https://github.com/iwpnd/toponym-api.git
cd toponym-api
pip install poetry
poetry install
pytest -v
```
## Deployment
see blogpost
## Authors
* **Benjamin Ramser** - *Initial work* - [iwpnd](https://github.com/iwpnd)
See also the list of [contributors](https://github.com/iwpnd/toponym-api/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details