Create a simple API from a dataframe!
Project description
RestDF
RestDF is a command line utility for running any pandas.DataFrame
compatible datasets as a Rest API, with built-in SwaggerUI
support.
- Source code: https://github.com/Mukhopadhyay/restdf
- License: MIT
- Documentation: http://restdf.rtfd.io/
Geting Started with RestDF
The goal of this project was to make the API creation process from a dataset simpler. So, the execution is kept as minimal as possible. For example,
RestDF
can be run like any other python module using the -m
flag, additional flags can be used to configure the server.
Following will start a server with this dataset on localhost:5000/docs
python -m restdf https://raw.githubusercontent.com/cs109/2014_data/master/diamonds.csv
For a more detailed description of all available flags and option please refer to this documentation on Command Line Arguments.
Endpoints
The responses from RestDF
can be categorized into following three broad categories:
Docs
Metadata
Data
Please refer to this page for more detailed documentation on the available endpoints.
Testing:
RestDF tests are written using pytest
. For more detailed documentation on testing this module please go to the following page: Testing RestDF
Documentations
Read the documentaion online at: http://restdf.rtfd.io/
Or build it locally from the docs/
directory using
Linux:
make html
Windows
make.bat html
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.