chg: [doc] updated to reference the MISP fork
parent
bf827bb6eb
commit
0f29ae5fd5
110
README.rst
110
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 <https://www.oasis-open.org/resources/open-repositories/>`__.
|
||||
See the `Governance <#governance>`__ section for more information.
|
||||
This is the MISP core team STIX2 library forked from the `OASIS TC Open Repository <https://www.oasis-open.org/resources/open-repositories/>`__.
|
||||
|
||||
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 <https://pip.pypa.io/en/stable/>`__:
|
|||
|
||||
.. 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 <https://stix2.readthedocs.io/en/latest/guide/ts_support.html>`__
|
||||
for details.
|
||||
|
||||
Governance
|
||||
----------
|
||||
Contributing
|
||||
------------
|
||||
|
||||
This GitHub public repository (**https://github.com/oasis-open/cti-python-stix2**) was
|
||||
`proposed <https://lists.oasis-open.org/archives/cti/201702/msg00008.html>`__ and
|
||||
`approved <https://www.oasis-open.org/committees/download.php/60009/>`__
|
||||
[`bis <https://issues.oasis-open.org/browse/TCADMIN-2549>`__] by the
|
||||
`OASIS Cyber Threat Intelligence (CTI) TC <https://www.oasis-open.org/committees/cti/>`__
|
||||
as an `OASIS TC Open Repository <https://www.oasis-open.org/resources/open-repositories/>`__
|
||||
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 <https://www.oasis-open.org/resources/open-repositories/>`__.
|
||||
|
||||
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
|
||||
<https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#governance-distinct-from-oasis-tc-process>`__
|
||||
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 <https://www.oasis-open.org/sites/www.oasis-open.org/files/BSD-3-Clause.txt>`__.
|
||||
That license was selected as the declared `"Applicable License" <https://www.oasis-open.org/resources/open-repositories/licenses>`__
|
||||
when the TC Open Repository was created.
|
||||
If you want to contribute, no need to sign a CLA.
|
||||
|
||||
As documented in `"Public Participation Invited
|
||||
<https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#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
|
||||
<https://www.oasis-open.org/policies-guidelines/open-repositories>`__,
|
||||
the open source `LICENSE <https://github.com/oasis-open/cti-python-stix2/blob/master/LICENSE>`__
|
||||
designated for this particular repository, and the requirement for an
|
||||
`Individual Contributor License Agreement <https://www.oasis-open.org/resources/open-repositories/cla/individual-cla>`__
|
||||
that governs intellectual property.
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
TC Open Repository `Maintainers <https://www.oasis-open.org/resources/open-repositories/maintainers-guide>`__
|
||||
are responsible for oversight of this project's community development
|
||||
activities, including evaluation of GitHub
|
||||
`pull requests <https://github.com/oasis-open/cti-python-stix2/blob/master/CONTRIBUTING.md#fork-and-pull-collaboration-model>`__
|
||||
and `preserving <https://www.oasis-open.org/policies-guidelines/open-repositories#repositoryManagement>`__
|
||||
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
|
||||
<https://www.oasis-open.org/resources/open-repositories/maintainers-guide#additionalMaintainers>`__.
|
||||
|
||||
.. _currentmaintainers:
|
||||
|
||||
**Current Maintainers of this TC Open Repository**
|
||||
|
||||
- `Jason Keirstead <mailto:Jason.Keirstead@ca.ibm.com>`__; GitHub ID:
|
||||
https://github.com/JasonKeirstead; WWW: `IBM <http://www.ibm.com/>`__
|
||||
|
||||
- `Emily Ratliff <mailto:Emily.Ratliff@ibm.com>`__; GitHub ID:
|
||||
https://github.com/ejratl; WWW: `IBM <http://www.ibm.com/>`__
|
||||
|
||||
- `Duncan Sparrell <mailto:duncan@sfractal.com>`__; GitHub ID:
|
||||
https://github.com/sparrell; WWW: `sFractal <http://sfractal.com/>`__
|
||||
|
||||
About OASIS TC Open Repositories
|
||||
--------------------------------
|
||||
|
||||
- `TC Open Repositories: Overview and Resources <https://www.oasis-open.org/resources/open-repositories/>`__
|
||||
- `Frequently Asked Questions <https://www.oasis-open.org/resources/open-repositories/faq>`__
|
||||
- `Open Source Licenses <https://www.oasis-open.org/resources/open-repositories/licenses>`__
|
||||
- `Contributor License Agreements (CLAs) <https://www.oasis-open.org/resources/open-repositories/cla>`__
|
||||
- `Maintainers' Guidelines and Agreement <https://www.oasis-open.org/resources/open-repositories/maintainers-guide>`__
|
||||
|
||||
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
|
||||
|
|
|
|||
Loading…
Reference in New Issue