Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Evan Wies <[email protected]>
  • Loading branch information
neomantra committed Jan 23, 2025
1 parent e6a6986 commit f740e60
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CHANGELOG

## v0.3.0 (unreleased)
## v0.3.0 (2025-01-22)

* Removed obsolete `Packaging` parameter from `dbn_hist.SubmitJob` and structs
* `dbn-go-file`: Do not include `.zst` suffix in Parquet destination file names
Expand Down
8 changes: 6 additions & 2 deletions cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ These tools are available as:

## `dbn-go-file`

`dbn-go-file` is a command-line tool to process DBN files. You can see an example of exercising it in [this script file](./tests/exercise_dbn-go-file.sh).
`dbn-go-file` is a command-line tool to process DBN files. You can see an example of exercising it in [this script file](../tests/exercise_dbn-go-file.sh).

```
$ dbn-go-file --help
Expand Down Expand Up @@ -101,7 +101,7 @@ writing to 'tests/split/GLBX.MDP3/ESH1/2020/12/28/ESH1.20201228.ohlcv-1s.dbn.zst

## `dbn-go-hist`

`dbn-go-hist` is a command-line tool to interact with the Databento Historical API. You can see an example of exercising it in [this script file](./tests/exercise_dbn-go-hist.sh). It requires your [Databento API Key](https://databento.com/portal/keys) to be set with `--key` or preferably via the `DATABENTO_API_KEY` environment variable.
`dbn-go-hist` is a command-line tool to interact with the Databento Historical API. You can see an example of exercising it in [this script file](../tests/exercise_dbn-go-hist.sh). It requires your [Databento API Key](https://databento.com/portal/keys) to be set with `--key` or preferably via the `DATABENTO_API_KEY` environment variable.

*CAUTION: This program may incur billing!*

Expand Down Expand Up @@ -147,6 +147,9 @@ IFEU.IMPACT
NDEX.IMPACT
OPRA.PILLAR
XNAS.ITCH

$ dbn-go-hist schemas -d DBEQ.BASIC --json
["mbo","mbp-1","mbp-10","tbbo","trades","ohlcv-1s","ohlcv-1m","ohlcv-1h","ohlcv-1d","definition","status"]
```

----
Expand Down Expand Up @@ -215,6 +218,7 @@ It has four main pages. See the bottom of each page for key bindings.
| **Datasets** | List datasets, their schemas, and costs |
| **Publishers** | List publishers and their datasets |

Currently, downloads are placed in the current working directory.

Here are some screenshots of each TUI page:

Expand Down

0 comments on commit f740e60

Please sign in to comment.