{"id":34051382,"url":"https://github.com/staadecker/formula-prompt","last_synced_at":"2026-04-08T15:32:41.425Z","repository":{"id":57431947,"uuid":"346419225","full_name":"staadecker/formula-prompt","owner":"staadecker","description":"Python package to run custom formulas in your command prompt.","archived":false,"fork":false,"pushed_at":"2021-04-07T04:44:47.000Z","size":81,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-27T19:46:30.064Z","etag":null,"topics":["extendable","formulas","prompts"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/formula-prompt/","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/staadecker.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":"2021-03-10T16:24:53.000Z","updated_at":"2021-04-07T04:44:49.000Z","dependencies_parsed_at":"2022-09-19T08:01:43.706Z","dependency_job_id":null,"html_url":"https://github.com/staadecker/formula-prompt","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/staadecker/formula-prompt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staadecker%2Fformula-prompt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staadecker%2Fformula-prompt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staadecker%2Fformula-prompt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staadecker%2Fformula-prompt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/staadecker","download_url":"https://codeload.github.com/staadecker/formula-prompt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/staadecker%2Fformula-prompt/sbom","scorecard":{"id":845229,"data":{"date":"2025-08-11","repo":{"name":"github.com/staadecker/formula-prompt","commit":"dfe0b2025a327d1da81146257c3def6693fdf1e4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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 'main'"],"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"}}]},"last_synced_at":"2025-08-23T21:15:32.814Z","repository_id":57431947,"created_at":"2025-08-23T21:15:32.814Z","updated_at":"2025-08-23T21:15:32.814Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31562688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["extendable","formulas","prompts"],"created_at":"2025-12-14T01:17:36.436Z","updated_at":"2026-04-08T15:32:41.418Z","avatar_url":"https://github.com/staadecker.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Formula Prompt\n\nThis library let's you define formulas that you can later\nevaluate in your command line. I use this library for school\nwork that requires repetitive calculations or calculations\nneeding a computer.\n\n## Example\n\nHere I define two formulas. Notice the `@register_formula(...)` decorator\nthat registers the formulas with the library.\n\n```python\nfrom formula_prompt import *\n\n@register_formula([NumInput(\"side length\")])\ndef volume_of_cube(s):\n  return s ** 3\n\n@register_formula([NumInput(\"length\"), NumInput(\"width\")])\ndef area_of_rectangle(length, width):\n  return length * width\n```\nNow that the library has registered the formulas, I can launch the prompt.\n```\nlaunch_prompt()\n```\n\nThe prompt lets you pick a formula and evaluate it.\n\n```\n0:\tarea_of_rectangle\n1:\tvolume_of_cube\n2:\tquit\nPick a formula:\n\u003e\u003e\u003e 1\nInput side length:\n\u003e\u003e\u003e 3\nvolume_of_cube:\n27.0\n```\n\nFor more examples, look at the [`/examples`](/examples) folder on GitHub.\n\n## How to use this library\n\n1. Install the library by running: `pip install formula-prompt`\n\n2. Write your formulas (see example above).\n\n3. Add the `@register_formula(...)` decorator (see below).\n\n4. Call `launch_prompt()`.\n\n\n### Using `@register_formula(...)`\n\n`@register_formula(...)` is a decorator that takes in a few parameters.\n\n\nname | Required | Description\n--- | --- | ---\n`func_inputs` | Yes | A list of objects describing the inputs to your formula (see allowed formula inputs section below).\n`decimal_places` | No. Defaults to 4. | Decimal places to round the results of your formula to. Specify `None` to disable rounding.\n`name` | No. Defaults to the function name. | Lets you set the name that will be displayed in the prompt. Names containing dots (`.`) will be considered folders. For example, `volumes.cube` will place the formula in a `volumes` folder and display the formula as `cube`.\n\n### Allowed formula inputs\n\nYou can specify three types of inputs.\n\n- `NumInput`: For inputs that accepts a single floating-point number.\n\n\n- `IntInput`: For inputs that accept a single integer.\n\n\n- `ListInput`: For inputs that accept a list of floating-point numbers.\n\nYou can use `optional=True` to allow skipping the input (this will pass `None`\nto your function).\n\nHere's an example.\n```python\n@register_formula([\n    IntInput(\"first optional input\", optional=True),\n    NumInput(\"second non-optional input\")\n])\ndef some_funtion(first_integer_input, second_float_input):\n    ...\n```\n\nYou can also make a custom input type by creating a class that inherits from `Inputs`. See [`inputs.py`](/formula_prompt/inputs.py).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaadecker%2Fformula-prompt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstaadecker%2Fformula-prompt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstaadecker%2Fformula-prompt/lists"}