Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sintel-dev/sintel
https://github.com/sintel-dev/sintel
flask restful-api signals
Last synced: about 22 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/sintel-dev/sintel
- Owner: sintel-dev
- License: mit
- Created: 2020-09-28T11:44:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T00:14:26.000Z (9 months ago)
- Last Synced: 2024-11-08T11:14:10.033Z (7 days ago)
- Topics: flask, restful-api, signals
- Language: Python
- Homepage:
- Size: 23 MB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
An open source project from Data to AI Lab at MIT.
[](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
[](https://pypi.python.org/pypi/sintel)
[](https://github.com/signals-dev/sintel/actions)
[](https://codecov.io/gh/signals-dev/sintel)
[](https://pepy.tech/project/sintel)
# Sintel
**Sintel** (Signal Intelligence) provides Restful APIs to process massive signal data for anomaly analysis in an efficient and user-friendly way.
* License: [MIT](https://github.com/signals-dev/sintel/blob/master/LICENSE)
* Development Status: [Pre-Alpha](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
* Homepage: https://github.com/sintel-dev/sintel
## Prerequisites
Make sure you have installed all of the following prerequisites on your development machine:
- **Python (>= 3.8)** - Sintel has been developed and runs on [Python 3.8](https://www.python.org/downloads/release/python-360/). Although it is not strictly required, the usage of a [virtualenv](https://virtualenv.pypa.io/en/latest/) is highly recommended in order to avoid interfering with other software installed in the system where **MTV** is run. To this end, [Anaconda python](https://www.anaconda.com/distribution/#download-section) is suggested to maintain the virtual environments.
- **Git** - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
- **MongoDB (>= 4.4)** - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
## Get Started
### Quick Install
Once you've downloaded the Sintel repository and installed all the prerequisites, you're just a few steps away from running your application. To install the project, create a virtualenv and execute
```bash
$ make install
```
This command will install all the dependencies needed for the application to run. For development, use the following command instead, which will install some additional
dependencies for code linting and testing
```bash
$ make install-develop
```
Download demo data and load it to the mongodb. The database name by default is `sintel`.
```bash
$ make load-db
```
### Running Your Application
Please activate your virtualenv, and then launch the API server:
```bash
$ sintel run -v
```
Go to the API playground ([http://localhost:3000/apidocs](http://localhost:3000/apidocs)) to have a try.
### Development
Run the following command for the purpose of development
```bash
$ sintel run -E development -v
```
### API Documentations
Once the server runs up, you should be able to open the following API interfaces:
- http://localhost:3000/apidocs (Swagger UI style)
- http://localhost:3000/redoc (Redoc UI style)
### Use Your Own Data
Follow the tutorial `.tutorials/Anomaly Detection.ipynb` for detail.
## Use Docker to deploy
- Install [Docker](https://docs.docker.com/install/) and [Compose](https://docs.docker.com/compose/install/)
- Load data into the mongo container
```bash
$ make docker-db-up
```
```bash
$ make docker-up
```
Go to the API playground ([http://localhost:3000/apidocs](http://localhost:3000/apidocs)) to have a try. For further commands, please refer to `Makefile`, the session of Docker Installation.