{"id":39497799,"url":"https://github.com/gebn/beam","last_synced_at":"2026-01-18T05:43:54.397Z","repository":{"id":57414384,"uuid":"75582048","full_name":"gebn/beam","owner":"gebn","description":"A lightweight wrapper for the SolusVM client API.","archived":false,"fork":false,"pushed_at":"2025-12-06T00:27:09.000Z","size":326,"stargazers_count":2,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-03T03:53:26.052Z","etag":null,"topics":["api-client","cloud-computing","solusvm"],"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/gebn.png","metadata":{"files":{"readme":"README.rst","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,"zenodo":null}},"created_at":"2016-12-05T02:42:36.000Z","updated_at":"2025-07-20T15:24:54.000Z","dependencies_parsed_at":"2024-04-14T20:22:10.253Z","dependency_job_id":"3feb197c-8e0c-4ab1-99ac-3fecdd8ecded","html_url":"https://github.com/gebn/beam","commit_stats":{"total_commits":92,"total_committers":3,"mean_commits":"30.666666666666668","dds":"0.13043478260869568","last_synced_commit":"4e424f3530e7284f00e0b04ae197a77b50b86afa"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/gebn/beam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gebn%2Fbeam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gebn%2Fbeam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gebn%2Fbeam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gebn%2Fbeam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gebn","download_url":"https://codeload.github.com/gebn/beam/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gebn%2Fbeam/sbom","scorecard":{"id":421268,"data":{"date":"2025-08-11","repo":{"name":"github.com/gebn/beam","commit":"112441a94de8d856f6ca024ce0bb279d6ea7930a"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/6 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":"Maintained","score":3,"reason":"4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yaml: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":"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":"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":"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/ci.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/gebn/beam/ci.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/gebn/beam/ci.yaml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/ci.yaml:18","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 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"}},{"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":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-230 / GHSA-248v-346w-9cwc","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v"],"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 24 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-19T01:16:01.627Z","repository_id":57414384,"created_at":"2025-08-19T01:16:01.628Z","updated_at":"2025-08-19T01:16:01.628Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28531368,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"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-client","cloud-computing","solusvm"],"created_at":"2026-01-18T05:43:54.335Z","updated_at":"2026-01-18T05:43:54.389Z","avatar_url":"https://github.com/gebn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"beam\n====\n\n.. image:: https://img.shields.io/pypi/status/beam.svg\n   :target: https://pypi.python.org/pypi/beam\n.. image:: https://img.shields.io/pypi/v/beam.svg\n   :target: https://pypi.python.org/pypi/beam\n.. image:: https://img.shields.io/pypi/pyversions/beam.svg\n   :target: https://pypi.python.org/pypi/beam\n.. image:: https://github.com/gebn/beam/actions/workflows/ci.yaml/badge.svg\n   :target: https://github.com/gebn/beam/actions/workflows/ci.yaml\n.. image:: https://coveralls.io/repos/github/gebn/beam/badge.svg?branch=master\n   :target: https://coveralls.io/github/gebn/beam?branch=master\n\nA lightweight wrapper for the SolusVM client API.\n\nFeatures\n--------\n\n-  Query a host's memory, bandwidth, IP addresses and storage usage.\n-  Boot, reboot and shutdown machines.\n-  Configurable to work with any SolusVM provider.\n-  Command line client and intuitive Python module for your own scripts.\n\nSetup\n-----\n\n1. Run ``pip install beam`` to download the module.\n2. Create your ``.beam.ini`` inventory file as below.\n\nInventory\n~~~~~~~~~\n\nThe inventory file holds information about your hosting provider(s) and host(s),\nso beam knows how to contact the relevant API endpoints and what credentials to\nuse. Here's a sample file:\n\n.. code::\n\n   [special:vendors]\n   ramnode = https://vpscp.ramnode.com\n   vendor2 = https://vendor2-panel.com\n   default = ramnode\n\n   [nyc-1]\n   key = nyc-1_host_key\n   hash = nyc-1_host_hash\n\n   [ams-1]\n   key = ams-1_host_key\n   hash = ams-1_host_hash\n   vendor = vendor2\n\nThis file defines two hosts, ``nyc-1``, hosted with RamNode, and ``ams-1``,\nhosted with FlipHost. At the top are the vendor names in a special vendors\nsection (all other sections are assumed to represent hosts). The format maps a\nvendor name to their base endpoint for the SolusVM API. The ``default``\ndirective indicates the implicit vendor of every host, and must be specified if\nmore than one vendor is defined.\n\nEach host has its own section. The correct ``key`` and ``hash`` values can be\noptained from the SolusVM control panel used by your vendor. If a host is not\nprovided by the default vendor, a ``vendor`` directive specifies the correct\none.\n\nUsage\n-----\n\nBeam provides both a Python library for programmatic access to your hosts, and\na simple CLI that wraps it in a couple of lines of code.\n\nCLI\n~~~\n\nThe CLI client can be used to find information about a single host.\n\n.. code::\n\n    $ beam --help\n    usage: beam [-h] [-V]\n                (-A {boot,reboot,shutdown} | -a ATTRIBUTES [ATTRIBUTES ...])\n                [host]\n\n    A lightweight wrapper for the SolusVM client API.\n\n    positional arguments:\n      host                  the identifier of the host whose information to\n                            retrieve\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      -V, --version         show program's version number and exit\n      -A {boot,reboot,shutdown}, --action {boot,reboot,shutdown}\n                            an action to execute against the host\n      -a ATTRIBUTES [ATTRIBUTES ...], --attributes ATTRIBUTES [ATTRIBUTES ...]\n                            one or more attributes of the host to retrieve\n    $ beam -a bandwidth.free_percentage nyc-1\n    0.4983459835\n    $ beam -a primary_ip lon-1\n    2604:180:2:32b::498b\n    $ beam -a is_online memory.used_bytes ams-1\n    True\n    34578234983\n    $ beam -A shutdown nyc-1\n    OK\n\nLibrary\n~~~~~~~\n\n.. code:: python\n\n    import beam\n\n    # shutdown a specific host\n    host = beam.host('nyc-1')  # name, key or hash\n    if host.is_online:\n        host.shutdown()\n\n    # boot all offline hosts\n    [host.boot() for host in beam.hosts() if not host.is_online]\n\n    # get a list of hosts using above 90% of their memory\n    hosts = [host for host in beam.hosts()\n             if host.memory.used_percentage \u003e .9]\n\n    # get a list of hosts with less than 10 GiB of storage left\n    hosts = [host for host in beam.hosts()\n             if host.storage.free_bytes \u003c 1024 ** 3 * 10]\n\nRoadmap\n-------\n\n-  Generate documentation.\n-  Increase unit test coverage to 100%, and implement some integration tests.\n\nEtymology\n---------\n\nAlthough \"solus\" means alone, that's a tad depressing. Solus also conjures up\nimages of the sun for me. The sun *beam*\\ s down - and the name was available on\nPyPI - so beam it was.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgebn%2Fbeam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgebn%2Fbeam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgebn%2Fbeam/lists"}