{"id":18773616,"url":"https://github.com/protocol/pystarboard","last_synced_at":"2025-07-31T01:08:11.895Z","repository":{"id":192886718,"uuid":"687664370","full_name":"protocol/pystarboard","owner":"protocol","description":"Python interface for Starboard data downloads","archived":false,"fork":false,"pushed_at":"2023-09-05T18:56:17.000Z","size":6,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-29T08:40:47.675Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-09-05T18:40:23.000Z","updated_at":"2023-09-20T04:53:39.000Z","dependencies_parsed_at":"2023-12-09T02:15:08.936Z","dependency_job_id":null,"html_url":"https://github.com/protocol/pystarboard","commit_stats":null,"previous_names":["protocol/pystarboard"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fpystarboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fpystarboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fpystarboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protocol%2Fpystarboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protocol","download_url":"https://codeload.github.com/protocol/pystarboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239680983,"owners_count":19679509,"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":[],"created_at":"2024-11-07T19:34:34.701Z","updated_at":"2025-02-19T15:16:26.327Z","avatar_url":"https://github.com/protocol.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyStarboard\n\nPython interface for querying starboard for Filecoin statistics, via Spacescope.\n\n\n## Prerequisites\nCheck the `setup.py` script for dependencies.\n\n## Installing\n\nThis package can be installed from source by cloning this repository and installing it manually with the command:\n\n```\npython setup.py install\n```\n\n## Setup for Data Access\n`pystarboard` is a convenient interface for pulling data from Spacescope. Spacescope requires users to register for a unique token in order to request the historical data. Thus, each user of `pystarboard` needs to register for a unique token to enable data access - this is a prerequisite to use `pystarboard`.  \n\n### Steps:\n1. Follow the instructions [here](https://spacescope.io/sign/up/email) to get your own unique bearer token for data access.\n2. Store your token in a json configuration file with the key `auth_key`.  An example is:\n```json\n{\n    \"auth_key\": \"Bearer ghp_xJtTSVcNRJINLWMmfDangcIFCjqPUNZenoVe\"\n}\n```\n\n## Usage\nYou will need to ensure that you setup your data access properly by running the following code\n```python\nimport pystarboard.data as data\npath_to_auth_cfg=\"\u003cUPDATE ME\u003e\"\ndata.setup_spacecope(path_to_auth_cfg)\n```\n\n## See also\n\n* [mechaFIL](https://github.com/protocol/filecoin-mecha-twin)\n* [mechafil-jax](https://github.com/protocol/mechafil-jax)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotocol%2Fpystarboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotocol%2Fpystarboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotocol%2Fpystarboard/lists"}