{"id":28449987,"url":"https://github.com/leomaurodesenv/data-science-api-framework","last_synced_at":"2025-09-09T08:48:33.289Z","repository":{"id":37673696,"uuid":"279964191","full_name":"leomaurodesenv/data-science-api-framework","owner":"leomaurodesenv","description":"A simple framework to test and deploy your Data Science API","archived":false,"fork":false,"pushed_at":"2025-03-25T12:45:44.000Z","size":44,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-06T14:43:58.947Z","etag":null,"topics":["api","api-rest","data-science","dataops","docker","flask-api","python"],"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/leomaurodesenv.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":"2020-07-15T19:55:29.000Z","updated_at":"2025-03-25T12:45:44.000Z","dependencies_parsed_at":"2024-04-25T06:52:33.309Z","dependency_job_id":null,"html_url":"https://github.com/leomaurodesenv/data-science-api-framework","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/leomaurodesenv/data-science-api-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fdata-science-api-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fdata-science-api-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fdata-science-api-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fdata-science-api-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leomaurodesenv","download_url":"https://codeload.github.com/leomaurodesenv/data-science-api-framework/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leomaurodesenv%2Fdata-science-api-framework/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274268373,"owners_count":25253390,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","api-rest","data-science","dataops","docker","flask-api","python"],"created_at":"2025-06-06T14:40:13.888Z","updated_at":"2025-09-09T08:48:33.281Z","avatar_url":"https://github.com/leomaurodesenv.png","language":"Python","readme":"# Data Science API Framework\n[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![GitHub](https://img.shields.io/badge/Code-GitHub-yellow.svg)](https://github.com/leomaurodesenv/data-science-api-framework)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ca9bfbcc15dc48eba5b5cd22dc8f1329)](https://www.codacy.com/manual/leomaurodesenv/data-science-api-framework?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=leomaurodesenv/data-science-api-framework\u0026amp;utm_campaign=Badge_Grade)\n[![Build Status](https://travis-ci.com/leomaurodesenv/data-science-api-framework.svg?branch=master)](https://travis-ci.com/leomaurodesenv/data-science-api-framework)\n   \nThis repository is the basis for a fast, efficient and scalable python API structure for data scientists.   \nThis framework presents a continuous integration test using [Travis CI](https://travis-ci.com/), a [Docker](https://www.docker.com/) image to deploy your data science project, and, finally, a simple API Restful implementation to allow security access for everyone; facilitating the documentation, test, development, and deployment for production.  \n\nCombing all these things, this framework provides an potential DataOps procedure for your project. \"DataOps is an automated, process-oriented methodology, used by analytic and data teams, to improve the quality and reduce the cycle time of data analytics ... DataOps focuses on continuous delivery by leveraging on-demand IT resources and by automating test and deployment\". [Wikipedia](https://en.wikipedia.org/wiki/DataOps).   \n\n![Idea](documentation/main-idea.png)\n\n---\n## Start Coding\n### Installation\n\nImportant links: [DockerHub](http://hub.docker.com/), [Documentation](https://docs.docker.com/).   \n\nEach Operating System (OS) have its own steps.   \n**Note**: Docker CE (Community Edition), Docker EE (Enterprise Edition).   \n\n### Running\n\nDownload or clone this repository, and run   \n\n```shell\n## Install requirements\n$ pip install --no-cache-dir -r ./requirements.txt\n\n## Running local - with Python\n$ uvicorn app.main:API --port 5050\n\n## Running local - with Docker\n$ docker build -t ds-api .\n$ docker run -it --rm --name api-container -p 5050:8080 ds-api\n\n## Open browser\n# http://127.0.0.1:8080/\n\n## Open browser - Swagger documentation\n# http://127.0.0.1:8080/docs\n```\n\nDone! You can access your API in http://localhost:5050/.   \n\n### Coding your API\n\nCreate your endpoint logic (API), such as [app/routers/hello_world.py](app/routers/hello_world.py).   \nAdd the new endpoint to [app/main.py](app/main.py); that is it, just run.   \n\n---\n## Deep personalization\n\nUseful personalizations:   \n-   Add Python libraries for your API; see [requirements.txt](requirements.txt).\n-   Add new API routers; see [app/main.py](app/main.py).\n-   Create new routers, such as [app/routers/hello_world.py](app/routers/hello_world.py).\n-   Improve the continuos integration tests; see [travis.yml](travis.yml).\n-   Improve the Docker image; see [Dockerfile](Dockerfile).\n-   Create an issue for any questions or suggestions!\n\n---\n## Also look ~\n\n-   License [MIT](LICENSE)\n-   Created by Leonardo Mauro ~ [leomaurodesenv](https://github.com/leomaurodesenv/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleomaurodesenv%2Fdata-science-api-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleomaurodesenv%2Fdata-science-api-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleomaurodesenv%2Fdata-science-api-framework/lists"}