/runik-dictionary-conversion-api

🛡️ The RESTful API microservice that converts human-readable files into dictionaries that are recognizable by various e-readers, such as Amazon Kindle and Kobo.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0


Logo

Runik Dictionary Conversion Microservice

🛡️ The RESTful API microservice that converts human-readable files into dictionaries that are recognizable by various e-readers, such as Amazon Kindle and Kobo. Uses the PyGlossary dictionary converter under the hood.

Built With

  • Flask
  • Python

Getting Started

1. Download starter and install dependencies

Clone this repository:

git clone git@github.com:Runik-3/runik-dictionary-conversion-api.git

Install npm dependencies:

cd runik-dictionary-conversion-api
pipenv install

2. Start Development Server

pipenv run gunicorn server:app -t 160

The server is now running on http://localhost:8000.

Usage

--

Roadmap

  • Add Logging
  • Unit Testing

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Contributors

This project exists thanks to all the people who contribute.

License

GPL-3.0 © Runik

Acknowledgments