diff options
| -rw-r--r-- | docs/conf.py | 3 | ||||
| -rw-r--r-- | docs/index.md | 13 | ||||
| l--------- | docs/notebooks | 1 | ||||
| -rw-r--r-- | notebooks/examples/dataset.ipynb | 65 | ||||
| -rw-r--r-- | requirements/dev_requirements.in | 2 | ||||
| -rw-r--r-- | requirements/dev_requirements.txt | 274 |
6 files changed, 340 insertions, 18 deletions
diff --git a/docs/conf.py b/docs/conf.py index 23392e9c..092fe3c4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,6 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) -from typing import List # -- Project information ----------------------------------------------------- @@ -31,7 +30,7 @@ release = "0.0.4" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions: List[str] = ["myst_parser"] +extensions = ["myst_nb"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/index.md b/docs/index.md index 4554a3b2..d8f04edf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,19 @@ # Sec-certs documentation +## Notebooks + +```{toctree} +:caption: Notebook examples +notebooks/dataset.ipynb +``` + +## GitHub artifacts + ```{toctree} :maxdepth: 2 +:caption: GitHub artifacts readme.md contributing.md code_of_conduct.md license.md -``` - +```
\ No newline at end of file diff --git a/docs/notebooks b/docs/notebooks new file mode 120000 index 00000000..b50be0f4 --- /dev/null +++ b/docs/notebooks @@ -0,0 +1 @@ +./../notebooks/examples
\ No newline at end of file diff --git a/notebooks/examples/dataset.ipynb b/notebooks/examples/dataset.ipynb new file mode 100644 index 00000000..7f9287aa --- /dev/null +++ b/notebooks/examples/dataset.ipynb @@ -0,0 +1,65 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Dataset class examples\n", + "\n", + "This notebook illustrates basic functionality with the `CCDataset` class that holds Common Criteria dataset" + ] + }, + { + "cell_type": "code", + "execution_count": 1, + "metadata": {}, + "outputs": [], + "source": [ + "from sec_certs.dataset.common_criteria import CCDataset" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "4985\n" + ] + } + ], + "source": [ + "dset = CCDataset.from_web_latest()\n", + "print(len(dset))" + ] + } + ], + "metadata": { + "interpreter": { + "hash": "6386d1612879d92d026c363e7667e428bc38d86c5a080d58c3d70e7cd43df67d" + }, + "kernelspec": { + "display_name": "Python 3.8.1 ('certsvenv': venv)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.1" + }, + "orig_nbformat": 4 + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/requirements/dev_requirements.in b/requirements/dev_requirements.in index 824a102f..baed56a5 100644 --- a/requirements/dev_requirements.in +++ b/requirements/dev_requirements.in @@ -12,5 +12,5 @@ flake8 pre-commit pip-tools sphinx -myst-parser +myst-nb sphinx-book-theme
\ No newline at end of file diff --git a/requirements/dev_requirements.txt b/requirements/dev_requirements.txt index 97debe7f..9c652d29 100644 --- a/requirements/dev_requirements.txt +++ b/requirements/dev_requirements.txt @@ -1,15 +1,41 @@ alabaster==0.7.12 # via sphinx +anyio==3.5.0 + # via jupyter-server +appnope==0.1.3 + # via + # ipykernel + # ipython +argon2-cffi==21.3.0 + # via + # jupyter-server + # notebook +argon2-cffi-bindings==21.2.0 + # via argon2-cffi +asttokens==2.0.5 + # via stack-data attrs==21.4.0 - # via pytest + # via + # jsonschema + # jupyter-cache + # markdown-it-py + # pytest babel==2.10.1 # via sphinx +backcall==0.2.0 + # via ipython beautifulsoup4==4.11.1 - # via pydata-sphinx-theme + # via + # nbconvert + # pydata-sphinx-theme black==22.3.0 # via -r dev_requirements.in +bleach==5.0.0 + # via nbconvert certifi==2021.10.8 # via requests +cffi==1.15.0 + # via argon2-cffi-bindings cfgv==3.3.1 # via pre-commit charset-normalizer==2.0.12 @@ -18,70 +44,203 @@ click==8.1.2 # via # black # pip-tools +colorama==0.4.4 + # via nbdime coverage[toml]==6.3.2 # via pytest-cov +debugpy==1.6.0 + # via ipykernel +decorator==5.1.1 + # via ipython +defusedxml==0.7.1 + # via nbconvert distlib==0.3.4 # via virtualenv docutils==0.17.1 # via + # myst-nb # myst-parser # pydata-sphinx-theme # sphinx + # sphinx-togglebutton +entrypoints==0.4 + # via + # jupyter-client + # nbconvert +executing==0.8.3 + # via stack-data +fastjsonschema==2.15.3 + # via nbformat filelock==3.6.0 # via virtualenv flake8==4.0.1 # via -r dev_requirements.in +gitdb==4.0.9 + # via gitpython +gitpython==3.1.27 + # via nbdime gprof2dot==2021.2.21 # via pytest-profiling +greenlet==1.1.2 + # via sqlalchemy identify==2.4.12 # via pre-commit idna==3.3 - # via requests + # via + # anyio + # requests imagesize==1.3.0 # via sphinx importlib-metadata==4.11.3 - # via sphinx + # via + # myst-nb + # sphinx +importlib-resources==5.7.1 + # via jsonschema iniconfig==1.1.1 # via pytest +ipykernel==6.13.0 + # via + # ipywidgets + # notebook +ipython==8.2.0 + # via + # ipykernel + # ipywidgets + # jupyter-sphinx + # myst-nb +ipython-genutils==0.2.0 + # via + # ipywidgets + # notebook +ipywidgets==7.7.0 + # via + # jupyter-sphinx + # myst-nb isort==5.10.1 # via -r dev_requirements.in +jedi==0.18.1 + # via ipython jinja2==3.1.1 # via + # jupyter-server # myst-parser + # nbconvert + # nbdime + # notebook # sphinx -markdown-it-py==2.1.0 +jsonschema==4.4.0 + # via nbformat +jupyter-cache==0.4.3 + # via myst-nb +jupyter-client==7.2.2 + # via + # ipykernel + # jupyter-server + # nbclient + # notebook +jupyter-core==4.10.0 + # via + # jupyter-client + # jupyter-server + # nbconvert + # nbformat + # notebook +jupyter-server==1.16.0 + # via + # jupyter-server-mathjax + # nbdime +jupyter-server-mathjax==0.2.5 + # via nbdime +jupyter-sphinx==0.3.2 + # via myst-nb +jupyterlab-pygments==0.2.2 + # via nbconvert +jupyterlab-widgets==1.1.0 + # via ipywidgets +markdown-it-py==1.1.0 # via # mdit-py-plugins # myst-parser markupsafe==2.1.1 - # via jinja2 + # via + # jinja2 + # nbconvert +matplotlib-inline==0.1.3 + # via + # ipykernel + # ipython mccabe==0.6.1 # via flake8 -mdit-py-plugins==0.3.0 +mdit-py-plugins==0.2.8 # via myst-parser -mdurl==0.1.1 - # via markdown-it-py memory-profiler==0.60.0 # via pytest-monitor +mistune==0.8.4 + # via nbconvert mypy==0.942 # via -r dev_requirements.in mypy-extensions==0.4.3 # via # black # mypy -myst-parser==0.17.2 +myst-nb==0.13.2 # via -r dev_requirements.in +myst-parser==0.15.2 + # via myst-nb +nbclient==0.5.13 + # via + # jupyter-cache + # nbconvert +nbconvert==6.5.0 + # via + # jupyter-server + # jupyter-sphinx + # myst-nb + # notebook +nbdime==3.1.1 + # via jupyter-cache +nbformat==5.3.0 + # via + # ipywidgets + # jupyter-cache + # jupyter-server + # jupyter-sphinx + # myst-nb + # nbclient + # nbconvert + # nbdime + # notebook +nest-asyncio==1.5.5 + # via + # ipykernel + # jupyter-client + # nbclient + # notebook nodeenv==1.6.0 # via pre-commit +notebook==6.4.11 + # via widgetsnbextension packaging==21.3 # via + # ipykernel + # jupyter-server + # nbconvert # pydata-sphinx-theme # pytest # sphinx +pandocfilters==1.5.0 + # via nbconvert +parso==0.8.3 + # via jedi pathspec==0.9.0 # via black pep517==0.12.0 # via pip-tools +pexpect==4.8.0 + # via ipython +pickleshare==0.7.5 + # via ipython pip-tools==6.5.1 # via -r dev_requirements.in platformdirs==2.5.1 @@ -92,22 +251,43 @@ pluggy==1.0.0 # via pytest pre-commit==2.18.1 # via -r dev_requirements.in +prometheus-client==0.14.1 + # via + # jupyter-server + # notebook +prompt-toolkit==3.0.29 + # via ipython psutil==5.9.0 # via + # ipykernel # memory-profiler # pytest-monitor +ptyprocess==0.7.0 + # via + # pexpect + # terminado +pure-eval==0.2.2 + # via stack-data py==1.11.0 # via pytest pycodestyle==2.8.0 # via flake8 +pycparser==2.21 + # via cffi pydata-sphinx-theme==0.8.1 # via sphinx-book-theme pyflakes==2.4.0 # via flake8 pygments==2.12.0 - # via sphinx + # via + # ipython + # nbconvert + # nbdime + # sphinx pyparsing==3.0.7 # via packaging +pyrsistent==0.18.1 + # via jsonschema pytest==7.1.1 # via # -r dev_requirements.in @@ -120,21 +300,41 @@ pytest-monitor==1.6.3 # via -r dev_requirements.in pytest-profiling==1.7.0 # via -r dev_requirements.in +python-dateutil==2.8.2 + # via jupyter-client pytz==2022.1 # via babel pyyaml==6.0 # via + # myst-nb # myst-parser # pre-commit # sphinx-book-theme +pyzmq==22.3.0 + # via + # jupyter-client + # jupyter-server + # notebook requests==2.27.1 # via + # nbdime # pytest-monitor # sphinx +send2trash==1.8.0 + # via + # jupyter-server + # notebook six==1.16.0 # via + # asttokens + # bleach # pytest-profiling + # python-dateutil # virtualenv +smmap==5.0.0 + # via gitdb +sniffio==1.2.0 + # via anyio snowballstemmer==2.2.0 # via sphinx soupsieve==2.3.2.post1 @@ -142,11 +342,16 @@ soupsieve==2.3.2.post1 sphinx==4.5.0 # via # -r dev_requirements.in + # jupyter-sphinx + # myst-nb # myst-parser # pydata-sphinx-theme # sphinx-book-theme + # sphinx-togglebutton sphinx-book-theme==0.3.2 # via -r dev_requirements.in +sphinx-togglebutton==0.3.1 + # via myst-nb sphinxcontrib-applehelp==1.0.2 # via sphinx sphinxcontrib-devhelp==1.0.2 @@ -159,6 +364,16 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx +sqlalchemy==1.4.35 + # via jupyter-cache +stack-data==0.2.0 + # via ipython +terminado==0.13.3 + # via + # jupyter-server + # notebook +tinycss2==1.1.1 + # via nbconvert toml==0.10.2 # via pre-commit tomli==2.0.1 @@ -168,6 +383,27 @@ tomli==2.0.1 # mypy # pep517 # pytest +tornado==6.1 + # via + # ipykernel + # jupyter-client + # jupyter-server + # nbdime + # notebook + # terminado +traitlets==5.1.1 + # via + # ipykernel + # ipython + # ipywidgets + # jupyter-client + # jupyter-core + # jupyter-server + # matplotlib-inline + # nbclient + # nbconvert + # nbformat + # notebook types-python-dateutil==2.8.10 # via -r dev_requirements.in types-pyyaml==6.0.5 @@ -180,17 +416,29 @@ typing-extensions==4.1.1 # via # black # mypy - # myst-parser urllib3==1.26.9 # via requests virtualenv==20.14.0 # via pre-commit +wcwidth==0.2.5 + # via prompt-toolkit +webencodings==0.5.1 + # via + # bleach + # tinycss2 +websocket-client==1.3.2 + # via jupyter-server wheel==0.37.1 # via # pip-tools # pytest-monitor + # sphinx-togglebutton +widgetsnbextension==3.6.0 + # via ipywidgets zipp==3.8.0 - # via importlib-metadata + # via + # importlib-metadata + # importlib-resources # The following packages are considered to be unsafe in a requirements file: # pip |