{"id":37075947,"url":"https://github.com/adamgilman/stairstep","last_synced_at":"2026-01-14T08:56:07.886Z","repository":{"id":57471036,"uuid":"137946413","full_name":"adamgilman/stairstep","owner":"adamgilman","description":"A Pythonic API for Amazon's States Language for defining AWS Step Functions ","archived":false,"fork":false,"pushed_at":"2023-01-19T08:36:04.000Z","size":475,"stargazers_count":8,"open_issues_count":9,"forks_count":6,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-11-24T05:24:42.513Z","etag":null,"topics":["aws","aws-step-functions","python","state-lanague","state-machine"],"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/adamgilman.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}},"created_at":"2018-06-19T21:14:31.000Z","updated_at":"2022-02-02T19:29:51.000Z","dependencies_parsed_at":"2023-02-10T21:30:35.008Z","dependency_job_id":null,"html_url":"https://github.com/adamgilman/stairstep","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adamgilman/stairstep","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamgilman%2Fstairstep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamgilman%2Fstairstep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamgilman%2Fstairstep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamgilman%2Fstairstep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamgilman","download_url":"https://codeload.github.com/adamgilman/stairstep/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamgilman%2Fstairstep/sbom","scorecard":{"id":165121,"data":{"date":"2025-08-11","repo":{"name":"github.com/adamgilman/stairstep","commit":"e1c64149feb75d2f192a5bf42c6287ca2905fdee"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/28 approved changesets -- score normalized to 0","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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"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":"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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"}},{"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE: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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 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"}}]},"last_synced_at":"2025-08-16T14:35:39.224Z","repository_id":57471036,"created_at":"2025-08-16T14:35:39.224Z","updated_at":"2025-08-16T14:35:39.224Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414714,"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":["aws","aws-step-functions","python","state-lanague","state-machine"],"created_at":"2026-01-14T08:56:07.200Z","updated_at":"2026-01-14T08:56:07.873Z","avatar_url":"https://github.com/adamgilman.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# stairstep\n\nStairStep is a Pythonic API for designing [AWS Step Functions](https://aws.amazon.com/step-functions/) using [Amazon's State Language](https://states-language.net/spec.html)\n\nInstead of hand crafting JSON, StairStep allows you define step functions using Python code which allows you to easily import information from outside sources and dynamically create step functions on the fly. \n\n# Development Progress / Coverage\n| Lanuage Feature  |  Type | Progress  | \n|---|---|---|\n| State  | Pass  | ✅  |\n| State  | Task  | ✅  |\n| State  | Succeed  | ✅  |\n| State  | Fail  | ✅  |\n| State  | Choice  | ✅  |\n| Field  | Common Validations  |  ✅  |\n| State  | Wait  | ✅ |\n| State  | Parallel  | Next 🛣 |\n\n\n# Examples\n* [Hello World](#helloworld)\n* [Complex Choice State](#choicestate)\n\n## \u003ca name=\"helloworld\"\u003e\u003c/a\u003e Hello World \nUsing the example from the [Amazon's State Language](https://states-language.net/spec.html#example) page\n\n```\n{\n    \"Comment\": \"A simple minimal example of the States language\",\n    \"StartAt\": \"Hello World\",\n    \"States\": {\n    \"Hello World\": { \n      \"Type\": \"Task\",\n      \"Resource\": \"arn:aws:lambda:us-east-1:123456789012:function:HelloWorld\",\n      \"End\": true\n    }\n  }\n}\n```\n\nWe can easily craft that in StairStep as follows\n\n```\n# Create a parent StairStep object\nss = StairStep(comment=\"A simple minimal example of the States language\", startAt=\"Hello World\")\n\n# Create the HelloWorld step\nhello = StateTask(name=\"Hello World\", resource=\"arn:aws:lambda:us-east-1:123456789012:function:HelloWorld\", end=True)\n\n# Add the step into the StairStep object\nss.addState(hello)\n\n# Create the Amazon State Language Export\nss.json()\n\n{  \n   \"Comment\":\"A simple minimal example of the States language\",\n   \"StartAt\":\"Hello World\",\n   \"States\":{  \n      \"Hello World\":{  \n         \"Type\":\"Task\",\n         \"Resource\":\"arn:aws:lambda:us-east-1:123456789012:function:HelloWorld\",\n         \"End\":true\n      }\n   }\n}\n```\n![hello_world](documentation/hello_world.png)\n\n## \u003ca name=\"choicestate\"\u003e\u003c/a\u003e Complex Choice State\n\n```\nss = StairStep(\n    comment = \"Example Choice State\",\n    startAt = \"ChoiceStateX\"\n)\n# Create a ChoiceRule, which is composed of choice expression(s)\n# This checks to see if the variable $.type is not \"Private\"\ntypeNotPrivate = ChoiceRule(operator=\"Not\", snext=\"Public\", conditions=\n    ChoiceExpression(operator=\"StringEquals\", variable=\"$.type\", value=\"Private\")\n)\n\n# This checks to see if the value of $.value is \u003e=20 or \u003c30\nvalueInTwenties = ChoiceRule(operator=\"And\", snext=\"ValueInTwenties\", conditions=\n    [\n        ChoiceExpression(operator=\"NumericGreaterThanEquals\", variable=\"$.value\", value=20),\n        ChoiceExpression(operator=\"NumericLessThan\", variable=\"$.value\", value=30)\n    ]\n)\nstate = StateChoice(name=\"ChoiceStateX\", choices=[typeNotPrivate,valueInTwenties],default=\"DefaultState\")\n\ndefault = StatePass(name=\"DefaultState\", end=True)\nin_twenties = StatePass(name=\"ValueInTwenties\", end=True)\npublic = StatePass(name=\"Public\", end=True)\n\nss.addState(state)\nss.addState(in_twenties)\nss.addState(public)\nss.addState(default)\nss.json()\n```\n\n```\n{\n\t\"Comment\": \"Example Choice State\",\n\t\"StartAt\": \"ChoiceStateX\",\n\t\"States\": {\n\t\t\"ChoiceStateX\": {\n\t\t\t\"Type\": \"Choice\",\n\t\t\t\"Default\": \"DefaultState\",\n\t\t\t\"Choices\": [{\n\t\t\t\t\"Next\": \"Public\",\n\t\t\t\t\"Not\": {\n\t\t\t\t\t\"Variable\": \"$.type\",\n\t\t\t\t\t\"StringEquals\": \"Private\"\n\t\t\t\t}\n\t\t\t}, {\n\t\t\t\t\"Next\": \"ValueInTwenties\",\n\t\t\t\t\"And\": [{\n\t\t\t\t\t\"Variable\": \"$.value\",\n\t\t\t\t\t\"NumericGreaterThanEquals\": 20\n\t\t\t\t}, {\n\t\t\t\t\t\"Variable\": \"$.value\",\n\t\t\t\t\t\"NumericLessThan\": 30\n\t\t\t\t}]\n\t\t\t}]\n\t\t},\n\t\t\"ValueInTwenties\": {\n\t\t\t\"Type\": \"Pass\",\n\t\t\t\"End\": true\n\t\t},\n\t\t\"Public\": {\n\t\t\t\"Type\": \"Pass\",\n\t\t\t\"End\": true\n\t\t},\n\t\t\"DefaultState\": {\n\t\t\t\"Type\": \"Pass\",\n\t\t\t\"End\": true\n\t\t}\n\t}\n}\n```\n![choice_state](documentation/choice_state.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamgilman%2Fstairstep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamgilman%2Fstairstep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamgilman%2Fstairstep/lists"}