Commit Graph

1454 Commits (master)

Author SHA1 Message Date
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
Emmanuelle Vargas-Gonzalez 10c005637e Minor changes to README. 2017-09-21 08:28:31 -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
Chris Lenk 4dfb5d2365 Test Environment layer 2017-09-08 09:01:12 -04:00
Richard Piazza ceb88f176e added TimestampConstant 2017-09-07 10:35:31 -04:00
Richard Piazza 95cac595da merge in latest 2017-09-07 10:18:02 -04:00
Chris Lenk 598f38921f Start Environment layer 2017-09-06 16:20:16 -04:00
Greg Back adac43708b Merge pull request #46 from oasis-open/markings
Marking Support
2017-09-05 19:08:45 +00:00
Greg Back c4f459752a Merge pull request #49 from emmanvg/datastores
Datastores Changes
2017-09-05 16:27:43 +00:00
Chris Lenk 42962e6675 Improve markings tests
- Test markings functions with both dictionaries and our _STIXBase-derived
  classes as input.
- Slightly improve test coverage.
- Drop Python 2.6 support.
2017-09-01 16:41:16 -04:00
Chris Lenk cc66e1a492 Make markings function signatures consistent
Put `marking` before `selectors`. The granular marking version of
`is_marked` requires selectors to not be None.
2017-09-01 10:50:01 -04:00
Emmanuelle Vargas-Gonzalez 6f36ea8488 Merge remote-tracking branch 'oasis/master' into datastores 2017-09-01 10:13:57 -04:00
Emmanuelle Vargas-Gonzalez 13f2810b25 Remove name positional argument, clean memory.py redundant codeother minor changes. Increase coverage. 2017-09-01 08:15:50 -04:00
Greg Back 124da846c3 Merge branch 'master' into markings 2017-08-31 20:36:59 +00:00
Greg Back da649d80ac Merge pull request #36 from oasis-open/datastores
Data stores
2017-08-31 20:15:49 +00:00
Greg Back b1054e780a Merge remote-tracking branch 'origin/master' into datastores 2017-08-31 19:52:48 +00:00
Greg Back 458b32d124 Merge pull request #48 from oasis-open/filter
Filter updates
2017-08-31 18:39:39 +00:00
Greg Back ba846f9501 Clean up some tests. 2017-08-31 18:23:08 +00:00
Greg Back 7b46283a5c Build filter function map 2017-08-31 18:21:29 +00:00
Greg Back 71d42b0e51 Merge remote-tracking branch 'origin/datastores' into filter 2017-08-31 17:18:20 +00:00
Chris Lenk 9d45a3dca2 Keep MALWARE_KWARGS to a minimal set
...but use an additional set with a description for marking tests.
2017-08-31 12:51:13 -04:00
Chris Lenk 15287959a4 Modify versioning API to work on dictionaries
This includes new_version() and revoke().
2017-08-31 12:28:07 -04:00
Chris Lenk 7bc6a60388 Merge pull request #47 from oasis-open/custom
Add support for custom extensions on Cyber Observables
2017-08-30 16:26:04 -04:00
clenk 8a33cb7716 Touch up ObjectReferenceProperty checks
- reword "_refs" error
- check with isinstance instead of __class__.__name__
2017-08-30 16:15:05 -04:00