diff --git a/docs/guide/DataStore, CompositeDataSource, Filters.ipynb b/docs/guide/datastore.ipynb similarity index 85% rename from docs/guide/DataStore, CompositeDataSource, Filters.ipynb rename to docs/guide/datastore.ipynb index 04662cc..f6d360b 100644 --- a/docs/guide/DataStore, CompositeDataSource, Filters.ipynb +++ b/docs/guide/datastore.ipynb @@ -1,5 +1,57 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# Delete this cell to re-enable tracebacks\n", + "import sys\n", + "ipython = get_ipython()\n", + "\n", + "def hide_traceback(exc_tuple=None, filename=None, tb_offset=None,\n", + " exception_only=False, running_compiled_code=False):\n", + " etype, value, tb = sys.exc_info()\n", + " return ipython._showtraceback(etype, value, ipython.InteractiveTB.get_exception_only(etype, value))\n", + "\n", + "ipython.showtraceback = hide_traceback" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# JSON output syntax highlighting\n", + "from __future__ import print_function\n", + "from pygments import highlight\n", + "from pygments.lexers import JsonLexer\n", + "from pygments.formatters import HtmlFormatter\n", + "from IPython.display import HTML\n", + "\n", + "original_print = print\n", + "\n", + "def json_print(inpt):\n", + " string = str(inpt)\n", + " if string[0] == '{':\n", + " formatter = HtmlFormatter()\n", + " return HTML('{}'.format(\n", + " formatter.get_style_defs('.highlight'),\n", + " highlight(string, JsonLexer(), formatter)))\n", + " else:\n", + " original_print(inpt)\n", + "\n", + "print = json_print" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -8,22 +60,6 @@ "\n", "CTI Python STIX2 features a new interface for pulling and pushing STIX2 content. The new interface consists of DataStore, DataSource and DataSink constructs: a DataSource for pulling STIX2 content, a DataSink for pushing STIX2 content, and a DataStore for pulling/pushing.\n", "\n", - "### DataSource API (snapshot)\n", - "* **get()** - search/retrieve most current STIX SDO/SRO via its ID\n", - "* **all_versions()** - search/retrieve all versions of STIX SDO/SRO via its id\n", - "* **query()** - search/retrieve STIX SDO/SRO(s) via search filters\n", - " \n", - "### DataSink API (snapshot)\n", - "* **add()** - add a set of STIX SDO/SRO to a target endpoint.\n", - " \n", - "### DataStore API (snapshot) \n", - "\n", - "(super set of the DataSource and DataSink)\n", - "* **get()**\n", - "* **all_versions()**\n", - "* **query()**\n", - "* **add()**\n", - "\n", "The DataStore, DataSource, DataSink (referred to as \"DataStore suite\") APIs are not referenced directly by a user but are used as base classes, which are then sublcassed into real DataStore suite(s). CTI Python STIX2 provides for the DataStore suites of **FileSystem**, **Memory**, and **TAXII**. Users are also encrouraged subclassing the base Data suite and creating their own custom DataStore suites." ] }, @@ -42,15 +78,9 @@ "A **CompositeDataSource** can also be attached to a **CompositeDataSource** for multiple layers of grouped **DataSources**.\n", "\n", "\n", - "### CompositeDataSource API (snapshot)\n", + "### CompositeDataSource API\n", "\n", - "* **get()** - search/retrieve from CompositeDataSource most current STIX object via its ID\n", - "* **all_versions()** - search/retrieve from CompositeDataSource all versions of STIX object via its ID\n", - "* **query()** - search/retrieve from CompositeDataSource STIX object(s) via search filters\n", - "* **add_data_source()** - Attach a DataSource to the CompositeDataSource\n", - "* **remove_data_source()** - Remove DataSource from the CompositeDataSource\n", - "\n", - "### CompositeDataSource Examples\n" + "#### CompositeDataSource Examples\n" ] }, { @@ -262,14 +292,14 @@ "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.12" + "pygments_lexer": "ipython3", + "version": "3.5.2" } }, "nbformat": 4, diff --git a/docs/guide/FileSystem.ipynb b/docs/guide/filesystem.ipynb similarity index 92% rename from docs/guide/FileSystem.ipynb rename to docs/guide/filesystem.ipynb index 9239131..c2e21b4 100644 --- a/docs/guide/FileSystem.ipynb +++ b/docs/guide/filesystem.ipynb @@ -1,5 +1,57 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# Delete this cell to re-enable tracebacks\n", + "import sys\n", + "ipython = get_ipython()\n", + "\n", + "def hide_traceback(exc_tuple=None, filename=None, tb_offset=None,\n", + " exception_only=False, running_compiled_code=False):\n", + " etype, value, tb = sys.exc_info()\n", + " return ipython._showtraceback(etype, value, ipython.InteractiveTB.get_exception_only(etype, value))\n", + "\n", + "ipython.showtraceback = hide_traceback" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# JSON output syntax highlighting\n", + "from __future__ import print_function\n", + "from pygments import highlight\n", + "from pygments.lexers import JsonLexer\n", + "from pygments.formatters import HtmlFormatter\n", + "from IPython.display import HTML\n", + "\n", + "original_print = print\n", + "\n", + "def json_print(inpt):\n", + " string = str(inpt)\n", + " if string[0] == '{':\n", + " formatter = HtmlFormatter()\n", + " return HTML('{}'.format(\n", + " formatter.get_style_defs('.highlight'),\n", + " highlight(string, JsonLexer(), formatter)))\n", + " else:\n", + " original_print(inpt)\n", + "\n", + "print = json_print" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -61,23 +113,6 @@ "\n", "### FileSystem API\n", "\n", - "\n", - "### FileSystemSource (snapshot)\n", - "* **get()** - search/retrieve most current STIX SDO/SRO via its ID\n", - "* **all_versions()** - search/retrieve all versions of STIX SDO/SRO via its id\n", - "* **query()** - search/retrieve STIX SDO/SRO(s) via search filters\n", - " \n", - "### FileSystemSink (snapshot)\n", - "* **add()** - add STIX SDO/SRO to a target file system endpoint.\n", - " \n", - "### FileSystemStore (snapshot)\n", - "\n", - "(super set of the FileSystemSource and FileSystemSink)\n", - "* **get()**\n", - "* **all_versions()**\n", - "* **query()**\n", - "* **add()**\n", - "\n", "A note on **get()**, **all_versions()**, and **query()**. The format of the STIX2 content targeted by the FileSystem suite is json files. When STIX2 content (in json) is retrieved by the **FileSystemStore** from disk, the content will attempt to be parsed into full-featured python STIX2 objects and returned as such. \n", "\n", "A note on **add()**. When STIX content is added (pushed) to the file system, the STIX content can be supplied in the following forms: python STIX objects, python dicts (of valid STIX objects or Bundles), json-encoded strings (of valid STIX objects or Bundles), or a (python)list of any of the previously listed types. Any of the previous STIX content forms will be converted to a STIX json object (in a STIX Bundle) and written to disk. \n", @@ -504,14 +539,14 @@ "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.12" + "pygments_lexer": "ipython3", + "version": "3.5.2" } }, "nbformat": 4, diff --git a/docs/guide/Memory.ipynb b/docs/guide/memory.ipynb similarity index 86% rename from docs/guide/Memory.ipynb rename to docs/guide/memory.ipynb index 29daae6..570425e 100644 --- a/docs/guide/Memory.ipynb +++ b/docs/guide/memory.ipynb @@ -1,5 +1,57 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# Delete this cell to re-enable tracebacks\n", + "import sys\n", + "ipython = get_ipython()\n", + "\n", + "def hide_traceback(exc_tuple=None, filename=None, tb_offset=None,\n", + " exception_only=False, running_compiled_code=False):\n", + " etype, value, tb = sys.exc_info()\n", + " return ipython._showtraceback(etype, value, ipython.InteractiveTB.get_exception_only(etype, value))\n", + "\n", + "ipython.showtraceback = hide_traceback" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# JSON output syntax highlighting\n", + "from __future__ import print_function\n", + "from pygments import highlight\n", + "from pygments.lexers import JsonLexer\n", + "from pygments.formatters import HtmlFormatter\n", + "from IPython.display import HTML\n", + "\n", + "original_print = print\n", + "\n", + "def json_print(inpt):\n", + " string = str(inpt)\n", + " if string[0] == '{':\n", + " formatter = HtmlFormatter()\n", + " return HTML('{}'.format(\n", + " formatter.get_style_defs('.highlight'),\n", + " highlight(string, JsonLexer(), formatter)))\n", + " else:\n", + " original_print(inpt)\n", + "\n", + "print = json_print" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -11,26 +63,6 @@ "\n", "### Memory API\n", "\n", - "### MemorySource (snapshot)\n", - "* **get()** - search/retrieve from memory most current STIX SDO/SRO via its ID\n", - "* **all_versions()** - search/retrieve from memory all versions of STIX SDO/SRO via its id\n", - "* **query()** - search/retrieve from memory STIX SDO/SRO(s) via search filters\n", - "* **load_from_file()** - load STIX content into memory from file\n", - " \n", - "### MemorySink (snapshot)\n", - "* **add()** - add a set of STIX SDO/SRO(s) to memory\n", - "* **save_to_file()** - save STIX content that is in memory to file\n", - " \n", - "### MemoryStore (snapshot)\n", - "\n", - "(super set of the MemorySource and MemorySink)\n", - "* **get()**\n", - "* **all_versions()**\n", - "* **query()**\n", - "* **load_from_file()**\n", - "* **save_to_file()**\n", - "* **add()**\n", - "\n", "A note on **load_from_file()** and **save()**. These methods both add STIX content to an internal dictionary (maintained by MemoryStore). STIX content that is to be added can be in the following forms: python STIX objects, python dicts (of valid STIX objects or Bundles), json-encoded strings (of valid STIX objects or Bundles), or a (python)list of any of the previously listed types. **MemoryStore** actually stores STIX content either as python STIX objects or as python dictionaries, reducing and converting any of the aforementioned types to one of those; and whatever form the STIX object is stored as , is what it will be returned as when queried or retrieved. Python STIX objects, and json-encoded strings (of STIX content) are stored as python STIX objects. Python dicts (of STIX objects) are stored as python dictionaries. This is done, as can be efficiently supported, in order to return STIX content in the form it was added to the **MemoryStore**. Also, for **load_from_file()**, STIX content is assumed to be in json form within the file, individually or in a Bundle. \n", "\n", "A note on **save_to_file()**. This method dumps all STIX content that is in MemoryStore to the specified file. The file format will be json, and the STIX content will be within a STIX Bundle. ntoe, the the output form will be a json STIX Bundle regardless of the form that the individual STIX objects are stored(i.e. supplied) to the MemoryStore. \n", @@ -263,14 +295,14 @@ "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.12" + "pygments_lexer": "ipython3", + "version": "3.5.2" } }, "nbformat": 4, diff --git a/docs/guide/TAXIICollection.ipynb b/docs/guide/taxii.ipynb similarity index 98% rename from docs/guide/TAXIICollection.ipynb rename to docs/guide/taxii.ipynb index 48b4656..2890659 100644 --- a/docs/guide/TAXIICollection.ipynb +++ b/docs/guide/taxii.ipynb @@ -1,5 +1,57 @@ { "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# Delete this cell to re-enable tracebacks\n", + "import sys\n", + "ipython = get_ipython()\n", + "\n", + "def hide_traceback(exc_tuple=None, filename=None, tb_offset=None,\n", + " exception_only=False, running_compiled_code=False):\n", + " etype, value, tb = sys.exc_info()\n", + " return ipython._showtraceback(etype, value, ipython.InteractiveTB.get_exception_only(etype, value))\n", + "\n", + "ipython.showtraceback = hide_traceback" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": { + "collapsed": true, + "nbsphinx": "hidden" + }, + "outputs": [], + "source": [ + "# JSON output syntax highlighting\n", + "from __future__ import print_function\n", + "from pygments import highlight\n", + "from pygments.lexers import JsonLexer\n", + "from pygments.formatters import HtmlFormatter\n", + "from IPython.display import HTML\n", + "\n", + "original_print = print\n", + "\n", + "def json_print(inpt):\n", + " string = str(inpt)\n", + " if string[0] == '{':\n", + " formatter = HtmlFormatter()\n", + " return HTML('{}'.format(\n", + " formatter.get_style_defs('.highlight'),\n", + " highlight(string, JsonLexer(), formatter)))\n", + " else:\n", + " original_print(inpt)\n", + "\n", + "print = json_print" + ] + }, { "cell_type": "markdown", "metadata": {}, @@ -12,22 +64,6 @@ "\n", "### TAXIICollection API\n", "\n", - "### TAXIICollectionSource\n", - "* **get()** - search/retrieve most current STIX SDO/SRO via its ID\n", - "* **all_versions()** - search/retrieve all versions of STIX SDO/SRO via its id\n", - "* **query()** - search/retrieve STIX SDO/SRO(s) via search filters\n", - "\n", - "### TAXIICollectionSink\n", - "* **add()** - add a set of STIX SDO/SRO to a TAXII Collection endpoint.\n", - "\n", - "### TAXIICollectionStore\n", - "\n", - "(super set of TAXIICollectionSource and TAXIICollectionSink)\n", - "* **get()**\n", - "* **all_versions()**\n", - "* **query()**\n", - "* **add()**\n", - "\n", "### TAXIICollection Examples\n", "\n", "#### TAXIICollectionSource" @@ -2491,14 +2527,14 @@ "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.12" + "pygments_lexer": "ipython3", + "version": "3.5.2" } }, "nbformat": 4,