{"id":20882689,"url":"https://github.com/galileo-galilei/kedro-serving","last_synced_at":"2025-05-12T18:31:05.499Z","repository":{"id":37794076,"uuid":"426787033","full_name":"Galileo-Galilei/kedro-serving","owner":"Galileo-Galilei","description":"A kedro-plugin to serve Kedro Pipelines as API","archived":false,"fork":false,"pushed_at":"2023-06-25T20:30:36.000Z","size":34,"stargazers_count":13,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-29T00:14:30.762Z","etag":null,"topics":["fastapi","kedro","kedro-plugin","mlops","model-serving","pipeline-serving","serving"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Galileo-Galilei.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-11-10T21:45:43.000Z","updated_at":"2023-01-10T17:28:30.000Z","dependencies_parsed_at":"2024-11-15T04:50:18.411Z","dependency_job_id":"ddeaa374-d1ea-4519-82b5-dfa74383a494","html_url":"https://github.com/Galileo-Galilei/kedro-serving","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"3788eba24368e7215836d5c33c564594d6ea5d1e"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galileo-Galilei%2Fkedro-serving","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galileo-Galilei%2Fkedro-serving/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galileo-Galilei%2Fkedro-serving/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galileo-Galilei%2Fkedro-serving/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Galileo-Galilei","download_url":"https://codeload.github.com/Galileo-Galilei/kedro-serving/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253797962,"owners_count":21965983,"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":["fastapi","kedro","kedro-plugin","mlops","model-serving","pipeline-serving","serving"],"created_at":"2024-11-18T07:33:02.519Z","updated_at":"2025-05-12T18:31:04.883Z","avatar_url":"https://github.com/Galileo-Galilei.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"**General informations**\n\n[![Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blue.svg)](https://pypi.org/project/kedro-serving/) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Code Style: Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/ambv/black)\n[![SemVer](https://img.shields.io/badge/semver-2.0.0-green)](https://semver.org/)\n\n----------------------------------------------------------\n| Software repository | Latest release                                                                                         | Total downloads                                                                                |\n| ------------------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |\n| Pypi                | [![PyPI version](https://badge.fury.io/py/kedro-serving.svg)](https://pypi.org/project/kedro-serving/) | [![Downloads](https://pepy.tech/badge/kedro-serving)](https://pepy.tech/project/kedro-serving) |\n\n**Code health**\n\n----------------------------------------------------------\n| Branch | Tests                                                                                                                                                                                          | Coverage                                                                                                                                                       | Links                                                                                                                                                                                                         | Documentation                                                                                                                             | Deployment                                                                                                                                                                                              | Activity                                                                                                                                                            |\n| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `main` | [![test](https://github.com/Galileo-Galilei/kedro-serving/workflows/test/badge.svg?branch=main)](https://github.com/Galileo-Galilei/kedro-serving/actions?query=workflow%3Atest+branch%3Amain) | [![codecov](https://codecov.io/gh/Galileo-Galilei/kedro-serving/branch/main/graph/badge.svg)](https://codecov.io/gh/Galileo-Galilei/kedro-serving/branch/main) | [![links](https://github.com/Galileo-Galilei/kedro-serving/workflows/check-links/badge.svg?branch=main)](https://github.com/Galileo-Galilei/kedro-serving/actions?query=workflow%3Acheck-links+branch%3Amain) | [![Documentation](https://readthedocs.org/projects/kedro-serving/badge/?version=stable)](https://kedro-serving.readthedocs.io/en/stable/) | [![publish](https://github.com/Galileo-Galilei/kedro-serving/workflows/publish/badge.svg?branch=main)](https://github.com/Galileo-Galilei/kedro-serving/actions?query=branch%3Amain+workflow%3Apublish) | [![commit](https://img.shields.io/github/commits-since/Galileo-Galilei/kedro-serving/0.0.1)](https://github.com/Galileo-Galilei/kedro-serving/compare/0.0.1...main) |\n\n# What is kedro-serving?\n\n`kedro-serving` is a kedro-plugn for serving kedro pipelines. It aims to be easy to use, flexible, robust to be production ready. **As it is in its early stage of developpement, it is highly discouraged to use it for production in its current state.**  \n\nComing soon:\n- enable parameters injection at runtime\n- supporting other inputs than pandas dataframe\n- documentation \u0026 examples\n- support for production-ready ASGI server (e.g., gunicorn)\n- extended configuration for artifacts\n- tests\n\n# How do I install kedro-serving?\n\n\n``kedro-serving`` is available on PyPI, so you can install it with ``pip``:\n\n```console\npip install kedro-serving\n```\n\nIf you want to use the most up to date version of the package which is under development and not released yet, you can install the package from github:\n\n```console\npip install --upgrade git+https://github.com/Galileo-Galilei/kedro-serving.git\n```\n\n\n# Getting started\n\n- Run `kedro info` to check if kedro recognizes kedro-serving as a plugin.\n- Change directory into your kedro project.\n- `kedro serving serve --pipeline my_pipeline_name --input-name my-input-name`\n  - For example, using the [spaceflight starter](https://docs.kedro.org/en/stable/tutorial/tutorial_template.html) project, I could run kedro-serving with this command: `kedro serving serve --pipeline data_processing --input-name companies`\n  - This sets up a server at http://localhost:5000 with two endpoints, `health` and `run`\n- Go to [http://localhost:5000/health](http://localhost:5000/health) to verify the server is running.\n- Use postman or similar to POST to [http://localhost:5000/run](http://localhost:5000/run) with a body containing a JSON list of records, like this example that works for the spaceflights starter:\n  - `[{\"id\": 1, \"company_rating\": 3, \"company_location\": \"TX\", \"total_fleet_count\": 23, \"iata_approved\": \"n\"}]`\n  - These records replace the input-name called out in the kedro-serving command when running the pipeline called out in the kedro-serving command.\n- If the records you pass in do not match the schema of the input-name you selected when initiating kedro-server, you will receive an error in JSON form.\n- If the pipeline run is successful, you will receive a response in JSON form containing the output data from the pipeline.\n\n# Release and roadmap\n\nThe [release history](https://github.com/Galileo-Galilei/kedro-serving/blob/main/CHANGELOG.md) centralizes packages improvements across time. The main features coming in next releases are [listed on github milestones](https://github.com/Galileo-Galilei/kedro-serving/milestones). Feel free to upvote/downvote and discuss prioritization in associated issues.\n\n# Disclaimer\n\nThis package is still in active development. We use [SemVer](https://semver.org/) principles to version our releases. Until we reach `1.0.0` milestone, breaking changes will lead to `\u003cminor\u003e` version number increment, while releases which do not introduce breaking changes in the API will lead to `\u003cpatch\u003e` version number increment.\n\nIf you want to see how to migrate from one version of `kedro-serving` to another, see the [migration guide](../docs/migration_guide.md).\n\n# Can I contribute?\n\nWe'd be happy to receive help to maintain and improve the package. Any PR will be considered (from typo in the docs to core features add-on) Please check the [contributing guidelines](https://github.com/Galileo-Galilei/kedro-serving/blob/main/CONTRIBUTING.md).\n\n# Main contributors\n\nThe following people actively maintain, enhance and discuss design to make this package as good as possible:\n\n- [Yolan Honoré-Rougé](https://github.com/Galileo-Galilei)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalileo-galilei%2Fkedro-serving","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalileo-galilei%2Fkedro-serving","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalileo-galilei%2Fkedro-serving/lists"}