DGF
/
dao-governance-framework
6
0
Fork 0
Code Issues 7 Pull Requests Packages Projects Releases Wiki Activity

semantic-scholar-client: Extend Readme

This commit is contained in:
Ladd Hoffman 2022-07-15 10:57:27 -05:00
parent 43462e84ea
commit ff7d6134f1
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
semantic-scholar-client/README.md
View File

@ -2,3 +2,15 @@ This utility is able to fetch data fromSemantic Scholar API.
Initial proof of concept here writes the result to stdout. Work in progress to pipe this data into an operating database. Initial proof of concept here writes the result to stdout. Work in progress to pipe this data into an operating database.
### Usage
cargo run -- --paper-id <paper_id>
`paper_id` is in accordance with [Semantic Scholar API](https://api.semanticscholar.org/api-docs/) rules.
In its current form the utility outputs the citation graph up to a depth of 3 citations.
Next steps include
- developing strategies for deciding where to terminate a given traversal
- providing an HTTP and perhaps 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.