Commit Graph

425 Commits (233ee7924e06f39f70eaef778e5c472c13d83d2c)

Author SHA1 Message Date
Chris Lenk 233ee7924e Merge branch 'master' into documentation 2017-10-04 10:38:40 -04:00
Greg Back 4990b7edb2 Merge pull request #60 from oasis-open/easier-markings
Easier markings
2017-10-04 14:58:01 +01:00
Chris Lenk 6ccea9bb2e Default to Py3 kernel in Jupyter notebooks
If no matching kernelspec is found a kernel with a matching `language`
("python") will be used
(https://ipython.org/ipython-doc/3/development/kernels.html).
2017-10-04 09:08:53 -04:00
Chris Lenk 3ca8cf820e Add STIXDomainObject and STIXRelationshipObject 2017-10-03 15:01:55 -04:00
Chris Lenk 2bdf83401a Add a shortcut for marking functions
So marking functions like `add_markings()` can be directly called as methods on
SDO/SRO classes. Note that they return new versions of the objects
because objects are immutable.
2017-10-03 10:28:58 -04:00
= a0c0e957ff CompositeDataSource guide - still incomplete as need to test execution 2017-10-02 17:33:03 -04:00
= 3b9e52ce19 parsing taxii filters not needed when retrieving by id 2017-10-02 16:43:08 -04:00
= 2321e8d54e taxii guide doc 2017-10-02 16:36:30 -04:00
Chris Lenk 58db629de8 Add markings functions to top level namespace 2017-10-02 16:09:38 -04:00
Chris Lenk 3a7ecd3d73 Use RST link syntax, not markdown 2017-10-02 15:55:05 -04:00
Chris Lenk f943e55abe Fix typo in README 2017-10-02 15:14:58 -04:00
Chris Lenk 33bf4fc8e3 Simplify README with link to ReadTheDocs 2017-10-02 13:22:07 -04:00
Chris Lenk 035f1a6c73 Support MarkingDefinition objs, not just ID strs
(when passed into `add_markings()` or `remove_markings()`)
2017-10-02 12:28:47 -04:00
Chris Lenk d737670210 Touch up enrivonment guide docs
based on recent DataStore bugfixes.
2017-10-02 09:24:21 -04:00
= fea2499ae2 forgot to pull doc branch down first, after having merged master into doc branch locally (to get access to DataStore/Filter code 2017-09-29 16:03:48 -04:00
= 6bfa516604 update to guide to match Filter code changes 2017-09-29 15:54:56 -04:00
= 4af665bf81 merge conflicts 2017-09-29 15:47:39 -04:00
Greg Back 9e21a69c7f Merge branch 'master' into documentation 2017-09-29 19:14:11 +00:00
= 815d0e2794 updating docs 2017-09-29 15:04:00 -04:00
Greg Back e2151659d7 Merge pull request #57 from oasis-open/bug_fixes
Update to Data* suite, FileSystem, Memory, TAXII and Filters
2017-09-29 19:57:42 +01:00
Greg Back b31b4f29f8 Handle inconsistent error messages between Python 2 and Python 3. 2017-09-29 18:45:15 +00:00
= ffa2242878 code changes brought about by discussion of pull request of 'bug_fixes' branch 2017-09-29 11:24:19 -04:00
Chris Lenk 0b24dcb373 Add JSON syntax highlighting to docs' output cells
Uses a hidden cell in the Jupyter notebook to monkeypatch print.
2017-09-26 19:41:19 -04:00
Chris Lenk ac97eb8bdc Add Environment documentation (Jupyter)
Has errors, needs #57.
2017-09-25 16:39:58 -04:00
= 54e917110e Merge branch 'documentation' of https://github.com/oasis-open/cti-python-stix2 into documentation 2017-09-24 18:15:53 -04:00
= e2a7b89975 guide docs for DataStore/Source/Sink, Memory, FileSystem, TAXIICollection 2017-09-24 18:14:15 -04:00
= 4450eb545b mistakenly tweaked output 2017-09-24 15:30:35 -04:00
Chris Lenk b6d1bb26de Improve utils docs, rename subpackage docs folders 2017-09-22 14:54:21 -04:00
= 55943847fa updated corresponding tests that would have broke 2017-09-22 11:49:54 -04:00
= 94df10bf8d docstrings redone; code changes for adding/returning STIX objects to FileSystem, Memory, TAXII; code changes for query sets and filters 2017-09-22 11:29:17 -04:00
Chris Lenk eac1ce94de Improve docstrings for Sphinx output
Also remove package and module names from classes and functions.

Also remove stix2.base from docs. We hide all private classes and
functions from the docs, so the only thing the documentation for base
included was STIXJSONEncoder.
2017-09-22 11:24:55 -04:00
Chris Lenk c0fd740e0a Improve autodoc output
- Add markings and sources
- Tidy up some docstrings
2017-09-22 10:01:00 -04:00
Chris Lenk d7efd1f752 Set up Sphinx autodoc
This will automatically generate API documentation from docstrings.
2017-09-21 17:27:13 -04:00
Greg Back a4819611e0 Update isort config. 2017-09-21 16:01:46 +00:00
Greg Back 5cb06e684c Update pre-commit config 2017-09-21 15:19:13 +00:00
Chris Lenk d54ac6e231 Add docs (Jupyter) for custom content 2017-09-21 09:34:02 -04:00
Chris Lenk 21d978acc8 Fix errors when instantiating custom classes
Defining a custom object/observable/extension class with no custom
__init__() function would result in an `AttributeError` or `TypeError`,
depending on if the class sub-classed `object` or not.
2017-09-21 09:11:01 -04:00
Chris Lenk c3a1c3dc3a Include IPython notebooks in Sphinx docs
Note: The first cell in each .ipynb file contains code to suppress
tracebacks in output cells. Thus cells that generate exceptions will
only output the error, without the traceback, which makes the
documentation easier to read.
2017-09-18 13:34:34 -04:00
Chris Lenk b9a4580a2e Add Data Markings documentation (Jupyter) 2017-09-15 13:14:54 -04:00
Chris Lenk efe6912890 Add documentation as Jupyter notebooks
- Creating STIX Content
- Serializing STIX Objects
- Parsing STIX Content
- Versioning
2017-09-15 09:53:00 -04:00
Greg Back 463d1e6b28 Merge pull request #52 from oasis-open/environment
Environment layer
2017-09-12 13:59:08 +00:00
Greg Back f070a4358e Merge pull request #54 from emmanvg/master
Update README and tox configuration
2017-09-11 16:40:12 +00:00
Emmanuelle Vargas-Gonzalez ec168e7bd0 Update README 2017-09-11 10:35:28 -04:00
Emmanuelle Vargas-Gonzalez 04450112bf Small change to tox.ini 2017-09-11 10:28:46 -04:00
Greg Back 87547c92f1 Merge pull request #50 from oasis-open/timestamp-constant
Timestamp constant
2017-09-11 13:12:19 +00:00
Greg Back f00dcb682a Fix imports 2017-09-11 13:00:40 +00:00
Greg Back 774acb23ea Remove extra newline 2017-09-11 11:56:23 +00:00
Chris Lenk 190b639126 Fix memory datastore to pass tests
1) 'stix_data' is now optional; you can set up a MemorySink without
needing a starting set of data.
2) Removed stix2-validator calls. The validator fails when called on our
_STIXBase-derived classes because we store timestamps as datetime
objects, while the validator expects strings. Also, this was the only
datastore that used the validator, and we should be consistent across
all of them. The validator can be added back in later.
2017-09-08 12:49:08 -04:00
Chris Lenk be07c32500 Add parse() to Environment layer
The Environment layer does not keep its own mapping of custom object types.
If we think it likely that users will want to maintain separate lists of
custom object types between two or more Environments, we can add this
later.
2017-09-08 12:40:01 -04:00
Chris Lenk f60331fb77 Improve docstrings for Environment layer 2017-09-08 11:15:10 -04:00