From 0f29ae5fd5ad8fd5a3468987e5a4c8cb79d37b5a Mon Sep 17 00:00:00 2001 From: Alexandre Dulaunoy Date: Wed, 24 Aug 2022 09:30:31 +0200 Subject: [PATCH] chg: [doc] updated to reference the MISP fork --- README.rst | 110 ++++++++--------------------------------------------- 1 file changed, 16 insertions(+), 94 deletions(-) diff --git a/README.rst b/README.rst index ca276cf..d82806c 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,9 @@ -|Build_Status| |Coverage| |Version| |Downloads_Badge| |Documentation_Status| +|Build_Status| |Coverage| |Version| |Downloads_Badge| cti-python-stix2 ================ -This is an `OASIS TC Open Repository `__. -See the `Governance <#governance>`__ section for more information. +This is the MISP core team STIX2 library forked from the `OASIS TC Open Repository `__. This repository provides Python APIs for serializing and de-serializing STIX2 JSON content, along with higher-level APIs for common tasks, including data @@ -19,7 +18,7 @@ Install with `pip `__: .. code-block:: bash - $ pip install stix2 + $ pip install misp-lib-stix2 Note: The library requires Python 3.6+. @@ -80,102 +79,25 @@ will be updated to automatically load the STIX Objects equivalent to the most recently supported CS. Please see the `library documentation `__ for details. -Governance ----------- +Contributing +------------ -This GitHub public repository (**https://github.com/oasis-open/cti-python-stix2**) was -`proposed `__ and -`approved `__ -[`bis `__] by the -`OASIS Cyber Threat Intelligence (CTI) TC `__ -as an `OASIS TC Open Repository `__ -to support development of open source resources related to Technical Committee work. +This is the MISP core team STIX2 library forked from the `OASIS TC Open Repository `__. -While this TC Open Repository remains associated with the sponsor TC, its -development priorities, leadership, intellectual property terms, participation -rules, and other matters of governance are `separate and distinct -`__ -from the OASIS TC Process and related policies. +The contributing rules of this repository is the MISP standard rules bound to the [Developer Certificate of Origin](https://www.misp-project.org/license/). -All contributions made to this TC Open Repository are subject to open -source license terms expressed in the `BSD-3-Clause License `__. -That license was selected as the declared `"Applicable License" `__ -when the TC Open Repository was created. +If you want to contribute, no need to sign a CLA. -As documented in `"Public Participation Invited -`__", -contributions to this OASIS TC Open Repository are invited from all parties, -whether affiliated with OASIS or not. Participants must have a GitHub account, -but no fees or OASIS membership obligations are required. Participation is -expected to be consistent with the `OASIS TC Open Repository Guidelines and Procedures -`__, -the open source `LICENSE `__ -designated for this particular repository, and the requirement for an -`Individual Contributor License Agreement `__ -that governs intellectual property. -Maintainers -~~~~~~~~~~~ - -TC Open Repository `Maintainers `__ -are responsible for oversight of this project's community development -activities, including evaluation of GitHub -`pull requests `__ -and `preserving `__ -open source principles of openness and fairness. Maintainers are recognized -and trusted experts who serve to implement community goals and consensus design -preferences. - -Initially, the associated TC members have designated one or more persons to -serve as Maintainer(s); subsequently, participating community members may -select additional or substitute Maintainers, per `consensus agreements -`__. - -.. _currentmaintainers: - -**Current Maintainers of this TC Open Repository** - -- `Jason Keirstead `__; GitHub ID: - https://github.com/JasonKeirstead; WWW: `IBM `__ - -- `Emily Ratliff `__; GitHub ID: - https://github.com/ejratl; WWW: `IBM `__ - -- `Duncan Sparrell `__; GitHub ID: - https://github.com/sparrell; WWW: `sFractal `__ - -About OASIS TC Open Repositories --------------------------------- - -- `TC Open Repositories: Overview and Resources `__ -- `Frequently Asked Questions `__ -- `Open Source Licenses `__ -- `Contributor License Agreements (CLAs) `__ -- `Maintainers' Guidelines and Agreement `__ - -Feedback --------- - -Questions or comments about this TC Open Repository's activities should be -composed as GitHub issues or comments. If use of an issue/comment is not -possible or appropriate, questions may be directed by email to the -Maintainer(s) `listed above <#currentmaintainers>`__. Please send general -questions about TC Open Repository participation to OASIS Staff at -repository-admin@oasis-open.org and any specific CLA-related questions -to repository-cla@oasis-open.org. - -.. |Build_Status| image:: https://github.com/oasis-open/cti-python-stix2/workflows/cti-python-stix2%20test%20harness/badge.svg - :target: https://github.com/oasis-open/cti-python-stix2/actions?query=workflow%3A%22cti-python-stix2+test+harness%22 +.. |Build_Status| image:: https://github.com/misp/cti-python-stix2/workflows/cti-python-stix2%20test%20harness/badge.svg + :target: https://github.com/misp/cti-python-stix2/actions?query=workflow%3A%22cti-python-stix2+test+harness%22 :alt: Build Status -.. |Coverage| image:: https://codecov.io/gh/oasis-open/cti-python-stix2/branch/master/graph/badge.svg - :target: https://codecov.io/gh/oasis-open/cti-python-stix2 +.. |Coverage| image:: https://codecov.io/gh/misp/cti-python-stix2/branch/main/graph/badge.svg + :target: https://codecov.io/gh/misp/cti-python-stix2 :alt: Coverage -.. |Version| image:: https://img.shields.io/pypi/v/stix2.svg?maxAge=3600 - :target: https://pypi.python.org/pypi/stix2/ +.. |Version| image:: https://img.shields.io/pypi/v/misp-lib-stix2.svg?maxAge=3600 + :target: https://pypi.python.org/pypi/misp-lib-stix2/ :alt: Version -.. |Downloads_Badge| image:: https://img.shields.io/pypi/dm/stix2.svg?maxAge=3600 - :target: https://pypi.python.org/pypi/stix2/ +.. |Downloads_Badge| image:: https://img.shields.io/pypi/dm/misp-lib-stix2.svg?maxAge=3600 + :target: https://pypi.python.org/pypi/misp-lib-stix2/ :alt: Downloads -.. |Documentation_Status| image:: https://readthedocs.org/projects/stix2/badge/?version=latest - :target: https://stix2.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status