Commit Graph

177 Commits (main)

Author SHA1 Message Date
Chris Lenk 585ade563c Fix a couple links in the docs 2022-10-17 11:54:09 -04:00
Chris Lenk 8c29b12fa1 Update docs dependencies
Fixes issues with doc builds failing.
2022-10-17 11:53:28 -04:00
Rich Piazza 31b8892681 doc version fixes 2021-07-13 12:38:01 -04:00
Rich Piazza eaf578ff5c
Merge pull request #521 from oasis-open/fix-custom-markings
Fix custom markings
2021-07-12 16:23:49 -04:00
Michael Chisholm 295037f92c Fix parsing.ipynb to not mention SCOs "inside" observed-data
SDOs anymore.  That is no longer the case in STIX 2.1.
2021-07-12 16:16:29 -04:00
Michael Chisholm 3cee753852 In extensions.ipynb, ran the JSON syntax highlighting cell before
running the other cells, to produce HTML highlighted output cells,
which I think had been the intent.  I forgot and it produced
plain text... oops.
2021-07-11 21:04:38 -04:00
Michael Chisholm 79ceef5100 Fix parsing.ipynb to not use the deprecated "objects" property
of the observed-data SDO.
2021-07-11 20:44:45 -04:00
Michael Chisholm 9f428c5efd Updates to extensions.ipynb:
- Change CS 02 reference to CS 03
- Fix typos
- Remove the extension definition from the first example.
It's not relevant.  Change the explanation to explain the
real reason why that example works: if unregistered toplevel
property extensions are present, the library lets unrecognized
toplevel properties pass.
- Change the explained rationale for registering an extension.
It had described "repetitive instantiation" of an extension, but
I think it was referring to an extension definition, and that is
not what happens.  The benefit of registration is that the library
will know which properties are associated with the extension and
can enforce their requirements.  Changed the commentary to explain
this.
- Fix the custom marking example to not use the @CustomMarking
decorator.  It is no longer used for extension-based custom
markings.  Instead, it just shows a normal extension being
registered and applied to a marking-definition.  The commentary
is changed to explain this too.
2021-07-11 20:16:55 -04:00
Michael Chisholm 92903a4525 Fix the CustomExtension example in the custom.ipynb jupyter
notebook.
2021-07-08 17:48:41 -04:00
Chris Lenk a002c1736d Update guide docs, remove outdated comments 2021-04-14 16:39:56 -04:00
Emmanuelle Vargas-Gonzalez 3cd05e6bdc
Update contributing.rst
remove Travis CI mention...
2021-04-02 13:04:08 -04:00
Emmanuelle Vargas-Gonzalez bc053da3c4 Merge branch 'master' of github.com:oasis-open/cti-python-stix2 into dev-extensions-proposal 2021-03-31 18:53:02 -04:00
Emmanuelle Vargas-Gonzalez af046beeb5 add new-sdo or new-sro option in CustomObject decorator, add a test, and example in guide 2021-03-31 18:46:37 -04:00
Emmanuelle Vargas-Gonzalez 08d5781f54 add entry on extensions.ipynb, typos, and a couple of fixes for registry module and Marking decorator 2021-03-31 18:11:38 -04:00
Emmanuelle Vargas-Gonzalez 294bd7309e add .serialize(pretty=True) around docs/guide/ to accommodate this change 2021-03-31 13:56:02 -04:00
Emmanuelle Vargas-Gonzalez 72a12e96ba update guide example, conf.py and remove some unused imports 2021-03-01 13:14:03 -05:00
Emmanuelle Vargas-Gonzalez ff5014c606 expose configuration options, combine weight dictionary, update tests 2021-03-01 12:27:52 -05:00
Chris Lenk 4825f5e303 Small touchups 2021-02-19 16:57:15 -05:00
Emmanuelle Vargas-Gonzalez ecf952c07b it updated itself... 2021-02-19 14:50:52 -05:00
Emmanuelle Vargas-Gonzalez 2308528957 add text and example for equivalence.ipynb 2021-02-19 14:48:23 -05:00
Chris Lenk 35f4bb0443 Update the semantic equivalence user guide page
Differentiate between similarity and equivalence, and update functions
to their new names and locations.
2021-02-18 23:45:38 -05:00
Chris Lenk b7b1b54afb Remove 'six' from config 2021-02-18 23:39:24 -05:00
Chris Lenk 71889b173f Touch up filesystem docs 2020-12-11 11:28:26 -05:00
Desai, Kartikey H 20a9bb316c Fix #476 2020-12-10 22:10:24 -06:00
Emmanuelle Vargas-Gonzalez 92ab1227ed docstrings, changes to equivalence.ipynb 2020-10-16 17:12:52 -04:00
Emmanuelle Vargas-Gonzalez fc600df5f1 update .gitignore and conf.py 2020-10-16 16:43:12 -04:00
Emmanuelle Vargas-Gonzalez 5ec001d324 add new rst files and directories 2020-10-16 16:42:17 -04:00
Emmanuelle Vargas-Gonzalez 7d99a9dab2 remove docs in wrong locations or directories 2020-10-16 16:40:25 -04:00
Emmanuelle Vargas-Gonzalez fb705c4885
Graph Equivalence (#449)
* new packages for graph and object-based semantic equivalence

* new method graphically_equivalent for Environment, move equivalence methods out

* object equivalence function, methods used for object-based moved here.

* new graph_equivalence methods

* add notes

* add support for versioning checks (default disabled)

* new tests to cover graph equivalence and new methods

* added more imports to environment.py to prevent breaking changes

* variable changes, new fields for checks, reset depth check per call

* flexibility when object is not available on graph.

* refactor debug logging message

* new file stix2.equivalence.graph_equivalence.rst and stix2.equivalence.object_equivalence.rst for docs

* API documentation for new modules

* additional text required to build docs

* add more test methods for list_semantic_check an graphically_equivalent/versioning

* add logging debug messages, code clean-up

* include individual scoring on results dict, fix issue on list_semantic_check not keeping highest score

* include results as summary in prop_scores, minor tweaks

* Update __init__.py

doctrings update

* apply feedback from pull request

- rename semantic_check to reference_check
- rename modules to graph and object respectively to eliminate redundancy
- remove created_by_ref and object_marking_refs from graph WEIGHTS and rebalance

* update docs/ entries

* add more checks, make max score based on actual objects checked instead of the full list, only create entry when type is present in WEIGHTS dictionary

update tests to reflect changes

* rename package patterns -> pattern

* documentation, moving weights around

* more documentation moving

* rename WEIGHTS variable for graph_equivalence
2020-10-16 11:35:26 -04:00
Emmanuelle Vargas-Gonzalez 639769d885 expose API Reference for Pattern Equivalence for ReadTheDocs 2020-09-11 13:54:13 -04:00
Emmanuelle Vargas-Gonzalez 08137ff6be add serialization to API documentation 2020-07-22 15:38:17 -04:00
Emmanuelle Vargas-Gonzalez 6daa9bd8a5 fix internal links to stix2.parsing.rst#stix2.parsing.parse 2020-07-01 11:21:53 -04:00
Emmanuelle Vargas-Gonzalez f2e044115b add newlines for stix2.v20.rst, stix2.v21.rst, stix2.confidence.rst 2020-07-01 10:32:51 -04:00
Emmanuelle Vargas-Gonzalez 1477effb2f add content for stix2.pattern_visitor.rst 2020-07-01 10:32:05 -04:00
Emmanuelle Vargas-Gonzalez fb0207fda8 add stix2.pattern_visitor.rst 2020-07-01 10:30:05 -04:00
Emmanuelle Vargas-Gonzalez bc2a6322a9 update ts_support.ipynb 2020-06-30 23:11:59 -04:00
Emmanuelle Vargas-Gonzalez 056bc4de19 update custom.ipynb
update JSON to STIX 2.1
2020-06-30 22:54:40 -04:00
Emmanuelle Vargas-Gonzalez 03ca082a50 update stix2.parsing.rst 2020-06-30 22:39:58 -04:00
Emmanuelle Vargas-Gonzalez 1518a6d55e add file stix2.parsing.rst 2020-06-30 22:35:40 -04:00
Emmanuelle Vargas-Gonzalez 2f80b82139 update stix2.versioning.rst 2020-06-30 22:35:03 -04:00
Emmanuelle Vargas-Gonzalez a9af34b1e3 add file stix2.versioning.rst 2020-06-30 22:34:38 -04:00
Emmanuelle Vargas-Gonzalez de4ea5b805 edits to parsing.ipynb and workbench.ipynb
Create the warning admonitions correctly
2020-06-30 22:11:29 -04:00
Emmanuelle Vargas-Gonzalez e957e80126 remove stix2.core.rst 2020-06-30 22:04:40 -04:00
Chris Lenk d5d664ba41 Update docs for 2.1 as default 2020-06-26 16:43:19 -04:00
Chris Lenk d260aa8ebd Tweak custom SCO ID-generating properties docs 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 5df319bcbb Add documentation about id-contributing properties for 2.1 custom SCOs 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 02171996fa Add documentation about _id_contributing_properties for custom SCOs. Will add in code example once PR 354 is merged in 2020-03-05 00:11:24 -05:00
Desai, Kartikey H 47b28d1194 Fixes #323 2020-03-05 00:11:24 -05:00
Michael Chisholm c6b2b6fbfa Change the warning in the jupyter notebook for creating content,
regarding name collisions between method and property names, to
not pick on the Mapping methods specifically.  The problem is
more general than that: stix objects have more methods than those.
Instead of listing them all out, a more general statement is
made, that accessing those attributes will result in a bound
method, not a STIX property value.
2020-02-03 16:51:12 -05:00
Michael Chisholm 1cadeaa1c6 Added a warning to creating.ipynb about Mapping attributes: they
can't be used to access STIX object properties.
2020-01-29 16:01:15 -05:00