{"id":37080804,"url":"https://github.com/a2i2/surround","last_synced_at":"2026-01-14T09:48:35.934Z","repository":{"id":34304804,"uuid":"161587586","full_name":"a2i2/surround","owner":"a2i2","description":"Surround is a framework for building AI driven microservices  in Python, https://surround.readthedocs.io/en/latest/","archived":false,"fork":false,"pushed_at":"2024-07-09T20:05:40.000Z","size":1552,"stargazers_count":23,"open_issues_count":38,"forks_count":29,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-10-29T15:29:40.861Z","etag":null,"topics":["data-science","machine-learning","model-serving","pipeline-framework","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a2i2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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}},"created_at":"2018-12-13T05:18:42.000Z","updated_at":"2024-09-30T00:33:11.000Z","dependencies_parsed_at":"2024-02-15T05:43:18.586Z","dependency_job_id":null,"html_url":"https://github.com/a2i2/surround","commit_stats":{"total_commits":774,"total_committers":11,"mean_commits":70.36363636363636,"dds":0.5400516795865633,"last_synced_commit":"effbb5353ae81d95a30306f94065ac2c8124ec44"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/a2i2/surround","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a2i2%2Fsurround","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a2i2%2Fsurround/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a2i2%2Fsurround/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a2i2%2Fsurround/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a2i2","download_url":"https://codeload.github.com/a2i2/surround/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a2i2%2Fsurround/sbom","scorecard":{"id":158132,"data":{"date":"2025-08-11","repo":{"name":"github.com/a2i2/surround","commit":"4bfe70d021868ece6e15c2c5b4cadafa7215612e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"name":"Code-Review","score":5,"reason":"Found 5/10 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":8,"reason":"2 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-38","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:135: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/a2i2/surround/build.yml/main?enable=pin","Warn: containerImage not pinned by hash: examples/hydra_example/Dockerfile:1: pin your Docker image by updating python:3.6.5 to python:3.6.5@sha256:c49ab7d5121521de57653c7209e68102d057ed77aff9859e8a9603b36105911a","Warn: containerImage not pinned by hash: examples/hydra_example/Dockerfile.Notebook:1","Warn: containerImage not pinned by hash: examples/runners/Dockerfile:1: pin your Docker image by updating python:3.6.5 to python:3.6.5@sha256:c49ab7d5121521de57653c7209e68102d057ed77aff9859e8a9603b36105911a","Warn: containerImage not pinned by hash: examples/simple_example/Dockerfile:1: pin your Docker image by updating python:3.8.10 to python:3.8.10@sha256:f7981c32c931f07d053f6867d7882169a9769528619e8dc475bf9b5cbec51679","Warn: containerImage not pinned by hash: examples/simple_example/Dockerfile.Notebook:1: pin your Docker image by updating python:3.8.10 to python:3.8.10@sha256:f7981c32c931f07d053f6867d7882169a9769528619e8dc475bf9b5cbec51679","Warn: containerImage not pinned by hash: examples/web_runner_sample/Dockerfile:1: pin your Docker image by updating python:3.10.6 to python:3.10.6@sha256:745efdfb7e4aac9a8422bd8c62d8bc35a693e8979a240d29677cb03e6aa91052","Warn: containerImage not pinned by hash: examples/web_runner_sample/Dockerfile.Notebook:1: pin your Docker image by updating python:3.10.6 to python:3.10.6@sha256:745efdfb7e4aac9a8422bd8c62d8bc35a693e8979a240d29677cb03e6aa91052","Warn: containerImage not pinned by hash: surround_cli/templates/new/Dockerfile.Notebook.txt:1: pin your Docker image by updating python:3.10.6 to python:3.10.6@sha256:745efdfb7e4aac9a8422bd8c62d8bc35a693e8979a240d29677cb03e6aa91052","Warn: containerImage not pinned by hash: surround_cli/templates/new/Dockerfile.txt:1: pin your Docker image by updating python:3.10.6 to python:3.10.6@sha256:745efdfb7e4aac9a8422bd8c62d8bc35a693e8979a240d29677cb03e6aa91052","Warn: pipCommand not pinned by hash: examples/hydra_example/Dockerfile:10","Warn: pipCommand not pinned by hash: examples/hydra_example/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: examples/hydra_example/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: examples/runners/Dockerfile:10","Warn: pipCommand not pinned by hash: examples/simple_example/Dockerfile:10","Warn: pipCommand not pinned by hash: examples/simple_example/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: examples/simple_example/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: examples/web_runner_sample/Dockerfile:10","Warn: pipCommand not pinned by hash: examples/web_runner_sample/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: examples/web_runner_sample/Dockerfile.Notebook:3","Warn: pipCommand not pinned by hash: surround_cli/templates/new/Dockerfile.Notebook.txt:3","Warn: pipCommand not pinned by hash: surround_cli/templates/new/Dockerfile.Notebook.txt:3","Warn: pipCommand not pinned by hash: surround_cli/templates/new/Dockerfile.txt:10","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:34","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:60","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:73","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:102","Warn: pipCommand not pinned by hash: .github/workflows/build.yml:148","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   9 containerImage dependencies pinned","Info:   0 out of  18 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-16T12:30:00.217Z","repository_id":34304804,"created_at":"2025-08-16T12:30:00.217Z","updated_at":"2025-08-16T12:30:00.217Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28416120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["data-science","machine-learning","model-serving","pipeline-framework","python"],"created_at":"2026-01-14T09:48:35.152Z","updated_at":"2026-01-14T09:48:35.929Z","avatar_url":"https://github.com/a2i2.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"./docs/source/temp_logo_hq.png\" width=\"500\"\u003e\n\u003c/p\u003e\n\nSurround is a lightweight framework for serving machine learning pipelines in Python. It is designed to be flexible, easy to use and to assist data scientists by focusing them on the problem at hand rather than writing glue code. Surround began as a project at the [Applied Artificial Intelligence Institute](https://a2i2.deakin.edu.au) to address the following problems:\n\n* The same changes were required again and again to refactor code written by data scientists to make it ready for serving e.g. no standard way to run scripts, no standard way to handle configuration and no standard pipeline architecture.\n* Existing model serving solutions focus on serving the model rather than serving an end-to-end solution. Our machine learning projects require multiple models and glue code to tie these models together.\n* Existing serving approaches do not allow for the evolution of a machine learning pipeline without re-engineering the solution i.e. using a cloud API for the first release before training a custom model much later on.\n* Code was commonly being commented out to run other branches as experimentation was not a first class citizen in the code being written.\n\n### Used in projects by:\n\n\u003cimg src=\"./docs/source/a2i2_logo.PNG\" width=\"300\"\u003e\n\n## Simple usage\n\nA short explanation is provided in the hello-world example's [README](examples/hello-world/) file.\n```python\nimport logging\nfrom surround import State, Stage, Estimator, Assembler, RunMode\n\nclass HelloWorld(Estimator):\n    def estimate(self, state, config):\n        state.text = \"Hello world\"\n\n    def fit(self, state, config):\n        print(\"No training implemented\")\n\nclass InputValidator(Stage):\n    def operate(self, state, config):\n        if state.text:\n            raise ValueError(\"'text' is not None\")\n\nclass AssemblerState(State):\n    text = None\n\nif __name__ == \"__main__\":\n    logging.basicConfig(level=logging.INFO)\n    data = AssemblerState()\n    assembler = Assembler(\"Hello world example\").set_stages([InputValidator(), HelloWorld()])\n    assembler.run(data, mode=RunMode.PREDICT)\n    print(\"Text is '%s'\" % data.text)\n```\n\n## Examples\n\nSee the [examples](https://github.com/dstil/surround/tree/master/examples) directory for useful examples on how Surround can be utilized.\n\n## Full Documentation\nSee [our website](https://surround.readthedocs.io/) for an in-depth explanation of Surround (in the About page), a Getting Started Guide, and full documentation of the API.\n\n## Contributing\n\nFor guidance on setting up a development environment and how to make a contribution to Surround, see the [contributing guidelines](docs/CONTRIBUTING.md).\n\n\n## License\n\nSurround is released under a [BSD-3](https://opensource.org/licenses/BSD-3-Clause) license.\n\n## Project Status\nSurround is currently under **heavy** development, please submit any issues that occur or suggestions you may have, it is very much appreciated!\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa2i2%2Fsurround","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa2i2%2Fsurround","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa2i2%2Fsurround/lists"}