Coder Social home page Coder Social logo

dartt0n / follow-my-reading Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 580 KB

Follow My Reading is an API service software project which is built during Summer 2023 Software Project course at Innopolis University

Ruby 0.03% Python 98.49% Dockerfile 1.01% Shell 0.08% Makefile 0.39%
api audio-processing fastapi gitlab-ci gitlab-migrated huey image-processing loguru mypy poetry

follow-my-reading's Introduction

License: MIT Packaging: poetry Linting: ruff Code style: black

FastAPI

Follow My Reading ๐Ÿ“˜

Follow My Reading provides a API service for our users to upload an image and audio of their reading session, and our service checks whether there are any mistakes in pronunciation in the audio.

Here's how it works โš™๏ธ

๐ŸŒ… users can take a photo of the page

๐Ÿ“– read the page aloud

๐ŸŽค record their audio

โฌ†๏ธ upload image and audio files to sever

:park: server can process image

๐ŸŽต server can process audio

๐ŸŒ… server can compare audio against image

๐Ÿ“„ server can compare audio against text

โฌ server can extract audio segments with requested phrases

Frameworks and technologies

FastAPI is a modern, fast (high-performance) web framework for building APIs with Python 3.6+ based on standard Python type hints, making it easy to write and maintain complex APIs in a fast and scalable way.

Redis is an open source, in-memory data structure store, used as a database, cache, and message broker, with support for a wide range of data structures and features that make it highly versatile and efficient.

Huey is a lightweight task queue for Python that allows for easy integration with Redis and asynchronous processing of tasks in distributed systems.

Full list of features โœจ

โœ… Image and audio upload

โœ… Audio Processing

โœ… Splitting audio by words or by phrases

โœ… Image Processing

โœ… Reporting text coordinates on the image

โœ… Comparing audio and image

โœ… Comparing audio and text

โœ… Extracting audio by given phrases

โœ… Plugin Support

โœ… Multi-language support

โœ… Distributed computing using Task System

โœ… Authentication

Documentation ๐Ÿ“„

We host the documentation for our API here: ๐ŸŒ Gitlab Pages, where you will find all the information you need to use our API effectively.

In addition to the API documentation, we also have a detailed wiki that explains everything in detail: ๐Ÿ“„ Project Wiki. This resource provides more comprehensive information, so feel free to take a deep dive and explore the different sections.

Team ๐Ÿ‘ฅ

  • @a.kudryavtsev
  • @a.soldatov
  • @i.sannikov
  • @f.smirnov
  • @l.novikov

License ๐Ÿ“ƒ

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

MIT License

follow-my-reading's People

Contributors

dartt0n avatar magiadrive avatar podyapolskiy avatar

Watchers

 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.