{"id":15905726,"url":"https://github.com/mukhopadhyay/restdf","last_synced_at":"2025-03-21T01:31:54.858Z","repository":{"id":46209705,"uuid":"410389188","full_name":"Mukhopadhyay/restdf","owner":"Mukhopadhyay","description":"Create a simple API from a DataFrame, with built-in SwaggerUI support.","archived":false,"fork":false,"pushed_at":"2024-02-26T13:45:44.000Z","size":133,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-24T20:38:01.248Z","etag":null,"topics":["dataframe","easy-to-use","etl","flask","flask-api","pandas","pandas-dataframe","python","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mukhopadhyay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-25T21:51:03.000Z","updated_at":"2024-10-31T19:57:17.000Z","dependencies_parsed_at":"2022-07-25T00:02:05.225Z","dependency_job_id":"102a963e-7bde-45f8-b00c-3ab6c1570145","html_url":"https://github.com/Mukhopadhyay/restdf","commit_stats":{"total_commits":63,"total_committers":1,"mean_commits":63.0,"dds":0.0,"last_synced_commit":"adeb6c188a20ecd9ee7eeafc12111e260072777e"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mukhopadhyay%2Frestdf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mukhopadhyay%2Frestdf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mukhopadhyay%2Frestdf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mukhopadhyay%2Frestdf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mukhopadhyay","download_url":"https://codeload.github.com/Mukhopadhyay/restdf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244721271,"owners_count":20498922,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dataframe","easy-to-use","etl","flask","flask-api","pandas","pandas-dataframe","python","rest-api"],"created_at":"2024-10-06T13:07:27.840Z","updated_at":"2025-03-21T01:31:54.494Z","avatar_url":"https://github.com/Mukhopadhyay.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RestDF\n\n[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg?style=for-the-badge\u0026logo=appveyor)](https://www.python.org/)\n[![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge\u0026logo=flask\u0026logoColor=white)](https://flask.palletsprojects.com/en/2.0.x/)\n\n[![Github Actions](https://github.com/Mukhopadhyay/restdf/actions/workflows/tests.yml/badge.svg)](https://github.com/Mukhopadhyay/restdf/actions)\n[![Documentation Status](https://readthedocs.org/projects/restdf/badge/?version=latest)](https://restdf.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/restdf.png)](https://pypi.org/project/restdf/)\n\n[![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen?style=flat-square)](https://github.com/Mukhopadhyay/restdf/blob/master/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\n**RestDF** is a command line utility for running any `pandas.DataFrame` compatible datasets as a Rest API, with built-in `SwaggerUI` support.\n\n* Source code: [https://github.com/Mukhopadhyay/restdf](https://github.com/Mukhopadhyay/restdf)\n* License: [MIT](https://github.com/Mukhopadhyay/restdf/blob/master/LICENSE)\n* Documentation: [http://restdf.rtfd.io/](http://restdf.rtfd.io/)\n\n### Installing `RestDF`\n**RestDF** can be installed from PyPi using\n```bash\npip install restdf\n```\n\n### Getting Started with `RestDF`\nThe 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, \u003cbr/\u003e\n`RestDF` can be run like any other python module using the `-m` flag, additional flags can be used to configure the server.\nFollowing will start a server with [this](https://raw.githubusercontent.com/cs109/2014_data/master/diamonds.csv) dataset on [localhost:5000/docs](http://localhost:5000/docs)\n\n```bash\nrestdf https://raw.githubusercontent.com/cs109/2014_data/master/diamonds.csv\n```\n\nor,\n\n```bash\npython -m restdf https://raw.githubusercontent.com/cs109/2014_data/master/diamonds.csv\n```\n\nFor a more detailed description of all available flags and option please refer to this documentation on [Command Line Arguments](https://restdf.readthedocs.io/en/latest/pages/command-line-arguments.html).\n\n### Endpoints\n\nThe responses from `RestDF` can be categorized into following three broad categories:\n* `Docs`\n* `Metadata`\n* `Data`\n\nPlease refer to [this](https://restdf.readthedocs.io/en/latest/pages/endpoints.html) page for more detailed documentation on the available endpoints.\n\n\n### Testing:\n**RestDF** tests are written using `pytest`. For more detailed documentation on testing this module please go to the following page: [Testing RestDF](https://restdf.readthedocs.io/en/latest/pages/tests.html)\n\n### Documentations\n\nRead the documentation online at: [http://restdf.rtfd.io/](http://restdf.rtfd.io/)\nOr build it locally from the `docs/` directory using\n\n**Linux:**\n```bash\nmake html\n```\n**Windows**\n```bash\nmake.bat html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmukhopadhyay%2Frestdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmukhopadhyay%2Frestdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmukhopadhyay%2Frestdf/lists"}