diff options
| author | Adam Janovsky | 2022-05-20 17:20:48 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-20 17:20:48 +0200 |
| commit | 9db545dbb2b644a01b8e49b4b2506ea03ec36b00 (patch) | |
| tree | b7a197b47a77ad46a7df1eef3af64c911c3641c4 /docs/quickstart.md | |
| parent | 4d7078d81f38d5ab4e31525ff8094be449e3b3b8 (diff) | |
| download | sec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.tar.gz sec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.tar.zst sec-certs-9db545dbb2b644a01b8e49b4b2506ea03ec36b00.zip | |
Docs: add some examples
Diffstat (limited to 'docs/quickstart.md')
| -rw-r--r-- | docs/quickstart.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md index 14121212..721e1341 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -6,6 +6,8 @@ 1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). 2. Use ```python +from sec-certs.dataset import CCDataset + dset = CCDataset.from_web_latest() ``` to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org). @@ -17,6 +19,8 @@ to obtain to obtain freshly processed dataset from [seccerts.org](https://seccer 1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). 2. Use ```python +from sec-certs.dataset import FIPSDataset + dset = FIPSDataset.from_web_latest() ``` to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org). @@ -45,4 +49,8 @@ $ fips-certs new-run ::: :::: -This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`.
\ No newline at end of file +This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`. + +:::{hint} +If you installed the docker image, use `docker run -it sec-certs bash` to run the container interactively. +::: |
