Skip to content

Commit bc01508

Browse files
authored
Update README.md (#13)
### Description <!---Why are we making this change? What does it do?---> marginally more doc ### Testing <!---How was this tested?---> ### Impact <!---What components does this impact? How can it affect prod?---> ### Other <!---What else can this impact? What special considerations are needed when reviewing the PR?---> ![image](https://github.com/user-attachments/assets/bafd3f28-88dd-44b8-a6e5-b992abe2b668)
2 parents 202b547 + 92ced6b commit bc01508

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# lens
22

3-
43
NUFT's data fetching from internal servers solution
54

65

7-
Only supporting Python 3.12 for now. Heavily in progress, more versions and whatnot soon.
8-
9-
106
## Usage
117
Lens provides a simple data fetching API. All queries require `startup` to be called on the instance before fetching.
128

9+
Startup validates the selected project root (or default: `/pool/lens`).
10+
Specific information on the contents of a data directory can be viewed in that directory's `metadata.json`.
11+
A complete example of the file layout is available in either `file_structure.md` (tree) or `test/testing_data`.
1312

1413
```python
1514
ln = Lens()
1615
ln.startup()
1716
df = ln.load_trades_for_day("avax", "2025-02-21")
17+
df = ln.load_depth_for_day("avax", "2025-02-21")
1818
```
19+
20+
These are the only two queries currently available, and both return `pd.DataFrame`. Headers are included.
21+
22+
`main.py` is included as a quick way to run the startup checks without needing to integrate with another codebase.
23+

0 commit comments

Comments
 (0)