https://github.com/protocol/pystarboard
Python interface for Starboard data downloads
https://github.com/protocol/pystarboard
Last synced: 6 months ago
JSON representation
Python interface for Starboard data downloads
- Host: GitHub
- URL: https://github.com/protocol/pystarboard
- Owner: protocol
- Created: 2023-09-05T18:40:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T18:56:17.000Z (over 2 years ago)
- Last Synced: 2024-12-29T08:40:47.675Z (about 1 year ago)
- Language: Python
- Size: 5.86 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PyStarboard
Python interface for querying starboard for Filecoin statistics, via Spacescope.
## Prerequisites
Check the `setup.py` script for dependencies.
## Installing
This package can be installed from source by cloning this repository and installing it manually with the command:
```
python setup.py install
```
## Setup for Data Access
`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`.
### Steps:
1. Follow the instructions [here](https://spacescope.io/sign/up/email) to get your own unique bearer token for data access.
2. Store your token in a json configuration file with the key `auth_key`. An example is:
```json
{
"auth_key": "Bearer ghp_xJtTSVcNRJINLWMmfDangcIFCjqPUNZenoVe"
}
```
## Usage
You will need to ensure that you setup your data access properly by running the following code
```python
import pystarboard.data as data
path_to_auth_cfg=""
data.setup_spacecope(path_to_auth_cfg)
```
## See also
* [mechaFIL](https://github.com/protocol/filecoin-mecha-twin)
* [mechafil-jax](https://github.com/protocol/mechafil-jax)