dao-governance-framework/semantic-scholar-client/README.md

25 lines
929 B
Markdown
Raw Normal View History

2022-11-07 17:31:37 -06:00
#`semantic-scholar-client`
2022-11-07 17:31:37 -06:00
This utility is able to fetch data from Semantic Scholar API.
Initial proof of concept here writes the result to stdout.
Work in progress to pipe this data into an operating database.
2022-07-15 10:57:27 -05:00
### Usage
2024-04-04 11:56:58 -05:00
* (Optional) Copy `.env.example` to `.env` and set the value of `SEMANTIC_SCHOLAR_API_KEY`
* Run the program
2022-11-07 17:31:37 -06:00
cargo run -- --paper-id <paper_id> --depth <depth>
2022-07-15 10:57:27 -05:00
2022-11-07 17:31:37 -06:00
* `paper_id` values are in accordance with [Semantic Scholar API](https://api.semanticscholar.org/api-docs/).
* `depth` is the number of citations to traverse, from the starting paper.
2022-07-15 10:57:27 -05:00
2022-11-07 17:31:37 -06:00
### Notes
2022-07-15 10:57:27 -05:00
2022-11-07 17:31:37 -06:00
Ideas for followup work:
- Consider strategies for deciding where to terminate a given traversal
- Provide an HTTP/WebSocket interface that can be used to talk to this process during its operation.
This can enable us to pipe the data to other tasks, to monitor, to start/stop, and even to make configuration changes.
2024-04-04 11:56:58 -05:00
- Rate limit requests