Commit Graph

162 Commits (bb1155e67841b40a28e69d82358e50512353d3e1)

Author SHA1 Message Date
Emmanuelle Vargas-Gonzalez 851ed3e85a marking-definition 2019-05-03 15:41:58 -04:00
Emmanuelle Vargas-Gonzalez 8d842aeb94 update user guide on marking extraction via API 2019-05-03 14:48:16 -04:00
Chris Lenk 0ca2bc087a Fix SDO link in docs 2019-02-06 14:27:33 -05:00
Emmanuelle Vargas-Gonzalez f80728d3f5 New files and directories for RST files. closes #234 2019-01-11 13:59:08 -05:00
Emmanuelle Vargas-Gonzalez db5f8f2ebf Update docstrings to relocate links\documentation 2019-01-11 13:55:05 -05:00
Emmanuelle Vargas-Gonzalez f12cc82d8a incorporate feedback
update documentation for core.py and automatic copyright year for docs
2018-12-11 13:22:04 -05:00
Emmanuelle Vargas-Gonzalez 3d099bec91 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into 1.1.0-release 2018-12-06 15:08:36 -05:00
Emmanuelle Vargas-Gonzalez ee14a116bd add new .rst documentation files 2018-11-28 17:03:02 -05:00
Emmanuelle Vargas-Gonzalez 7aad97307e use stix2 version to update documentation 2018-11-28 09:20:26 -05:00
Michael Chisholm 0cecbeb9d8 Ran trailing-whitespace pre-commit hook. It changed a bunch of
files, in ways we don't completely understand...
2018-11-27 15:24:08 -05:00
Emmanuelle Vargas-Gonzalez d01e6b47af Bump version: 1.0.3 → 1.0.4 2018-11-15 11:10:50 -05:00
Chris Lenk c4668f5dc1
Revert "Multi version filesystem store" 2018-11-07 10:10:06 -05:00
Michael Chisholm 9f83f2140b Ran trailing-whitespace pre-commit hook. It changed a bunch of
files, in ways we don't completely understand...
2018-11-06 15:10:40 -05:00
Emmanuelle Vargas-Gonzalez 5abe518b8a Bump version: 1.0.3 → 1.1.0 2018-11-01 09:55:37 -04:00
Emmanuelle Vargas-Gonzalez eff5369670 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into stix2.1 2018-11-01 07:57:09 -04:00
Emmanuelle Vargas-Gonzalez f85f4e566b Bump version: 1.0.2 → 1.0.3 2018-10-31 13:46:47 -04:00
Emmanuelle Vargas-Gonzalez e521e24387 Update the details on technical specification support 2018-10-31 13:39:09 -04:00
Chris Lenk 6613b55a43 Update MemoryStore documentation
...now that MemorySource normalizes its data to python-stix2 objects.
2018-10-23 14:29:56 -04:00
Emmanuelle Vargas-Gonzalez b2ef77b322 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into stix2.1 2018-10-17 07:30:23 -04:00
Chris Lenk b70aed0ef7 Make a few word changes in patterning guide 2018-09-10 21:29:08 -04:00
mbastian1135 5648d2bc45 added to pattern guide; reverting pattern str conversion (as was already proper) 2018-08-30 11:57:20 -04:00
mbastian1135 27dbaa5a65 guide edits 2018-08-27 16:51:02 -04:00
mbastian1135 0ef9060ed0 added 'to_pattern()' utility for pattern expressions; more information on patterning guide 2018-08-27 16:27:56 -04:00
mbastian1135 10149b9345 added 'to_pattern()' utility for pattern expressions; more information on patterning guide 2018-08-27 16:21:14 -04:00
Emmanuelle Vargas-Gonzalez 51a499cb33 Formatting changes made by the new pre-commit hook 'add trailing commas'
closes #189
2018-07-13 11:10:05 -04:00
Greg Back 49c1931b4b
Merge pull request #203 from oasis-open/200-filter-contains
Add "contains" filter
2018-07-05 15:47:09 -05:00
Chris Lenk f47809eaaf Add "contains" filter
This allows filtering on, for example, observed-data objects that
contain a specific cyber observable.
2018-07-02 18:28:27 -04:00
Greg Back 845625c174 GH-188: WIP: Converting all IDs to be valid UUID v4. 2018-06-27 11:35:55 -05:00
Chris Lenk 636630a5aa Bump version: 1.0.1 → 1.0.2 2018-05-18 13:06:32 -04:00
Chris Lenk 102623b29a Bump version: 1.0.0 → 1.0.1 2018-04-27 16:51:47 -04:00
Emmanuelle Vargas-Gonzalez 5d96cf11f1 Update TAXII2 filter fields in documentation 2018-04-24 15:55:46 -04:00
Chris Lenk 161e10ec40 Bump version: 0.5.1 → 1.0.0 2018-04-16 14:57:35 -04:00
Chris Lenk f66fbb73d9 Update CHANGELOG, docs for v1.0.0 2018-04-16 14:56:23 -04:00
= 4734711137 corresponding doc update 2018-04-13 15:07:49 -04:00
Chris Lenk b851afba01 Req. custom extension properties as list of tuples 2018-04-09 15:34:39 -04:00
Chris Lenk f83d9a56b5 Clean up documentation 2018-04-09 13:29:53 -04:00
Chris Lenk 5791810906 Ensure all guide doc output cells have [Out] label
Fixes #105.
2018-04-05 16:44:44 -04:00
Greg Back a1ad90d43f
Merge pull request #150 from oasis-open/38-workbench
Create Workbench layer
2018-04-05 10:09:23 -05:00
Chris Lenk a1af05a14e Warn against using workbench with the rest of lib
Doing so may cause issues because the workbench overwrites the STIX
Object mapping.
2018-04-04 09:47:48 -04:00
= 90834c5b95 docs and tests for parse() mod 2018-03-30 13:21:07 -04:00
Chris Lenk 4a2ac6df3a Add/fix workbench docs, rename add() -> save() 2018-03-30 12:04:31 -04:00
Chris Lenk b9bbd03481 Update workbench imports and documentation
Import a bunch of stuff so users can just "from stix2.workbench import *" and
not need to import other stuff (e.g. MarkingDefinition, Cyber Observable
Object classes, etc.) from stix2.
2018-03-30 12:04:31 -04:00
Chris Lenk efede51453 Skip documenting some workbench stuff 2018-03-30 12:04:31 -04:00
Chris Lenk 198b4ecffa Tweak property autodocumenter
- Skip the 'type' property, since it shouldn't be overridden.
- Add info on default values (currently this is only used for timestamp
properties, setting them to the current time).
- Rename it to STIXPropertyDocumenter since they're called properties in
STIX instead of attributes.
2018-03-16 16:14:21 -04:00
Chris Lenk bc72f93424 Add warning about TAXIICollection bug
Related: #125.
2018-03-15 18:07:14 -04:00
Chris Lenk 955cad8385 Clarify serialization in documentation 2018-03-13 16:01:42 -04:00
Chris Lenk f9523f24bf Bump version: 0.5.0 → 0.5.1 2018-03-06 12:05:53 -05:00
Chris Lenk 35679e6a6b Bump version: 0.4.0 → 0.5.0 2018-03-06 11:45:06 -05:00
Chris Lenk eb2d87ce71 Rename "DataStore" class to "DataStoreMixin"
Fix #116.
2018-03-01 11:27:37 -05:00
Chris Lenk 5f703509be Rename "sources" subpackage to "datastore"
Fix #114.
2018-03-01 09:04:42 -05:00
Chris Lenk 9402cff110
Merge pull request #131 from oasis-open/taxii_collection_source_404
Data source/store/sink changes
2018-02-27 17:04:14 -05:00
Chris Lenk 57eb709c48 Merge branch 'master' into taxii_collection_source_404 2018-02-26 17:08:28 -05:00
Chris Lenk df57f4d159 Fix typos in datasources 2018-02-26 16:56:24 -05:00
Chris Lenk aaff2a3a04 Appease pycodestyle 2018-02-22 09:55:15 -05:00
Chris Lenk 6f35978ba6 Document STIX object properties' metadata
(i.e. property type, whether it is required)
2018-02-21 16:46:13 -05:00
Chris Lenk 3263c3848f List STIX objects' properties in documentation 2018-02-21 16:46:13 -05:00
Chris Lenk f1813f17e0 Fix a couple links in documentation
Also upgrade nbsphinx version.
2018-02-21 16:46:13 -05:00
Mo a758c7e1b2
Update datastore.ipynb 2018-01-31 17:24:57 +00:00
Greg Back 126094106e Merge branch 'master' into taxii_collection_source_404 2017-11-29 22:13:16 +00:00
Chris Lenk db9c93d9e1 Add documentation for related object functions 2017-11-21 17:32:17 -05:00
= ec42182cb1 issue #107 , also MemorySource.load_from_file() parses JSON into python-stix2 objects now 2017-11-17 12:19:06 -05:00
= da4e843993 issue #104 with TAXIICollectionSource tweak 2017-11-16 17:47:27 -05:00
Chris Lenk ef3ce9f6f0 Bump version: 0.3.0 → 0.4.0 2017-11-13 16:40:58 -05:00
Chris Lenk 2dc8a97a51 Fix documentation links for v20 2017-11-13 14:14:24 -05:00
Chris Lenk 60c3aa0167 Fix redundant Data Markings example
To show both uses of get_markings()
2017-11-13 09:44:00 -05:00
Chris Lenk 7495ea6588 Add inter-documentation links
So when users read the guide docs, they can click a link to go to a
relevant section in the API reference.
2017-11-09 15:42:59 -05:00
Emmanuelle Vargas-Gonzalez 6f1ab52aa5 Update Jupyter Notebook documentation 2017-11-03 14:22:15 -04:00
Emmanuelle Vargas-Gonzalez a17d770d34 Merge master 2017-11-01 14:17:41 -04:00
Emmanuelle Vargas-Gonzalez 06a50b0178 Update README, add DEFAULT_VERSION 2017-11-01 10:48:28 -04:00
Emmanuelle Vargas-Gonzalez ef20860400 Detele support.ipynb 2017-11-01 10:03:03 -04:00
Emmanuelle Vargas-Gonzalez e985d3b1d5 Move ts_support to Jupiter Notebook 2017-11-01 10:01:41 -04:00
= d8e4f1ab98 addessing requested changes 2017-10-31 13:48:31 -04:00
Emmanuelle Vargas-Gonzalez b9d25a8375 Add notebook docs, fix package distribution 2017-10-28 00:32:28 -04:00
Emmanuelle Vargas-Gonzalez 942a95a4e2 Update documentation 2017-10-27 12:38:25 -04:00
= 313c6f56ff guide output 2017-10-25 14:38:25 -04:00
= 7092990565 tested code with jupyter notebook and local TAXII server 2017-10-25 14:36:20 -04:00
Chris Lenk 3c80e5e7eb Update Environment/Workbench layer progress 2017-10-06 16:10:36 -04:00
Chris Lenk 51361216e9 Bump version: 0.2.0 → 0.3.0 2017-10-06 15:40:34 -04:00
Chris Lenk 8b702c6985 Minor API docs improvements
- Hide "Bases" below class signatures
- Leave some empty space after tables
2017-10-05 20:44:58 -04:00
Chris Lenk 9c7f49688f Improve consistency across guide docs 2017-10-05 20:21:11 -04:00
= ec34aa952f Merge branch 'documentation' of https://github.com/oasis-open/cti-python-stix2 into documentation 2017-10-04 15:59:04 -04:00
= f7c17d0c07 some progress on CompositeDS guide, but includes some bug fixes in the DataSource API 2017-10-04 15:57:38 -04:00
Chris Lenk 1c9a16ea77 Update markings docs with latest update 2017-10-04 11:05:33 -04: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
= a0c0e957ff CompositeDataSource guide - still incomplete as need to test execution 2017-10-02 17:33:03 -04:00
= 2321e8d54e taxii guide doc 2017-10-02 16:36:30 -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
= 815d0e2794 updating docs 2017-09-29 15:04:00 -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
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
Chris Lenk d54ac6e231 Add docs (Jupyter) for custom content 2017-09-21 09:34:02 -04:00