{"id":16928688,"url":"https://github.com/peterjclaw/srcomp","last_synced_at":"2025-04-10T17:41:48.978Z","repository":{"id":15032529,"uuid":"17758374","full_name":"PeterJCLaw/srcomp","owner":"PeterJCLaw","description":"Reliable software for running robotics competitions","archived":false,"fork":false,"pushed_at":"2025-04-10T11:32:42.000Z","size":710,"stargazers_count":0,"open_issues_count":20,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-10T12:05:54.502Z","etag":null,"topics":["srcomp"],"latest_commit_sha":null,"homepage":"https://github.com/PeterJCLaw/srcomp/wiki","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PeterJCLaw.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":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-03-14T19:55:49.000Z","updated_at":"2025-04-10T11:30:47.000Z","dependencies_parsed_at":"2024-04-13T23:26:51.698Z","dependency_job_id":"3a930c12-803c-4dee-b8fb-21bc33ddcc15","html_url":"https://github.com/PeterJCLaw/srcomp","commit_stats":{"total_commits":665,"total_committers":4,"mean_commits":166.25,"dds":"0.20300751879699253","last_synced_commit":"67c3cc05ba993c684f828c0e7120a0f4a838a9bd"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterJCLaw%2Fsrcomp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterJCLaw%2Fsrcomp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterJCLaw%2Fsrcomp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterJCLaw%2Fsrcomp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PeterJCLaw","download_url":"https://codeload.github.com/PeterJCLaw/srcomp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248262191,"owners_count":21074260,"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":["srcomp"],"created_at":"2024-10-13T20:37:26.233Z","updated_at":"2025-04-10T17:41:48.942Z","avatar_url":"https://github.com/PeterJCLaw.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"SRComp\n======\n\n|Build Status| |Docs Status|\n\nReliable software for running robotics competitions, primarily used by\n`Student Robotics \u003chttps://studentrobotics.org\u003e`__.\n\nThe `SRComp wiki \u003chttps://github.com/PeterJCLaw/srcomp/wiki\u003e`__ provides\nan overview of the suite as a whole.\n\nThis repository provides a python API to accessing information about the\nstate of the competition. That *compstate* is stored as a collection of\nYAML files in a git repository. This allows the state of the competition\nto be managed in isolation from the software while still providing\nconsistent representations of that state.\n\nUsage\n-----\n\nPython clients should install the library using:\n\n.. code:: shell\n\n    pip install sr.comp\n\nOnly the ``SRComp`` is class directly exposed, and it should be constructed\naround the path to a local working copy of a *compstate repo*.\n\n.. code:: python\n\n    from srcomp import SRComp\n    comp = SRComp('/path/to/compstate')\n\n**Web clients** should look at using the HTTP API provided by\n`srcomp-http \u003chttps://github.com/PeterJCLaw/srcomp-http\u003e`__\nrather than implementing their own intermediary.\n\nThere is also a **command line** interface which provides utilities for\nmanaging a *compstate repo*:\n`srcomp-cli \u003chttps://github.com/PeterJCLaw/srcomp-cli\u003e`__.\n\nSee the\n`dummy-comp \u003chttps://github.com/PeterJCLaw/dummy-comp\u003e`__\nfor an example of the structure and values expected in a *compstate\nrepo*.\n\nDevelopment\n-----------\n\n**Install**:\n``pip install -e . -r dev-requirements.txt``\n\n**Checks**:\n``./script/check``\n\n.. |Build Status| image:: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main.svg?style=svg\n   :target: https://circleci.com/gh/PeterJCLaw/srcomp/tree/main\n\n.. |Docs Status| image:: https://readthedocs.org/projects/srcomp/badge/?version=latest\n   :target: https://srcomp.readthedocs.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterjclaw%2Fsrcomp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterjclaw%2Fsrcomp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterjclaw%2Fsrcomp/lists"}