Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ updates:
day: "saturday"
time: "09:00"
timezone: "America/New_York"
target-branch: "master"
target-branch: "main"
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ More detailed information and examples about the specific usage of the additiona

| module | description | documentation |
|:------------|:------------|:--------------|
| [navlayers](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/navlayers) | A collection of utilities for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) layers. Provides the ability to import, export, and manipulate layers. Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/navlayers/README.md).|
| [attackToExcel](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/attackToExcel) | A collection of utilities for converting [ATT&CK STIX data](https://github.com/mitre/cti) to Excel spreadsheets. It also provides access to [Pandas](https://pandas.pydata.org/) DataFrames representing the dataset for use in data analysis. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/attackToExcel/README.md).|
| [collections](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/collections) | A set of utilities for working with [ATT&CK Collections and Collection Indexes](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md). Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/collections/README.md).|
| [diffStix](https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/diffStix) | Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two versions of the STIX2 bundles representing the ATT&CK content. Run `diff_stix -h` for full usage instructions. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/master/mitreattack/diffStix/README.md).|
| [navlayers](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/navlayers) | A collection of utilities for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) layers. Provides the ability to import, export, and manipulate layers. Layers can be read in from the filesystem or python dictionaries, combined and edited, and then exported to excel or SVG images. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/navlayers/README.md).|
| [attackToExcel](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/attackToExcel) | A collection of utilities for converting [ATT&CK STIX data](https://github.com/mitre/cti) to Excel spreadsheets. It also provides access to [Pandas](https://pandas.pydata.org/) DataFrames representing the dataset for use in data analysis. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/attackToExcel/README.md).|
| [collections](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/collections) | A set of utilities for working with [ATT&CK Collections and Collection Indexes](https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md). Provides functionalities for converting and summarizing data in collections and collection indexes, as well as generating a collection from a raw stix bundle input. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/collections/README.md).|
| [diffStix](https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/diffStix) | Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two versions of the STIX2 bundles representing the ATT&CK content. Run `diff_stix -h` for full usage instructions. | Further documentation can be found [here](https://github.com/mitre-attack/mitreattack-python/blob/main/mitreattack/diffStix/README.md).|


## Related MITRE Work
Expand Down Expand Up @@ -70,7 +70,7 @@ One-off scripts and code examples you can use as inspiration for how to work wit
## Contributing

To contribute to this project, either through a bug report, feature request, or merge request,
please see the [Contributors Guide](https://github.com/mitre-attack/mitreattack-python/blob/master/docs/CONTRIBUTING.md).
please see the [Contributors Guide](https://github.com/mitre-attack/mitreattack-python/blob/main/docs/CONTRIBUTING.md).

## Notice

Expand Down
6 changes: 3 additions & 3 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

In order to release a new version of mitreattack-python, follow the process outlined here:

1. Verify that all changes desired in the next release are present in the `master` branch.
1. Verify that all changes desired in the next release are present in the `main` branch.

- If this is for an ATT&CK release, make sure to update the `LATEST_VERSION` in `mitreattack/release_info.py`.

2. Verify that all changes are documented in the CHANGELOG staged in the `master` branch.
2. Verify that all changes are documented in the CHANGELOG staged in the `main` branch.
3. Build the _mitreattack-python_ package from source and install it locally:
1. [Optional] Activate a virtualenv. e.g., `source ./venv/bin/activate`
2. Uninstall any older/previously installed versions of mitreattack-python: `pip uninstall mitreattack-python`
Expand All @@ -27,7 +27,7 @@ In order to release a new version of mitreattack-python, follow the process outl
Update other fields in setup.py as necessary (used libraries, etc.)
6. Commit any uncommitted changes.
7. Tag the release:
1. Tag the `master` branch with the version number - `git tag -a "vA.B.C" -m "mitreattack-python version A.B.C"`
1. Tag the `main` branch with the version number - `git tag -a "vA.B.C" -m "mitreattack-python version A.B.C"`
2. Push both the commit and the tag - `git push`/`git push --tags`
8. Verify that the package uploaded correctly
1. Check that GitHub Actions succeeded: <https://github.com/mitre-attack/mitreattack-python/actions>
Expand Down
6 changes: 3 additions & 3 deletions docs/additional_modules/attackToExcel.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
attackToExcel
==============================================

A collection of utilities for converting `ATT&CK STIX data`_ to Excel spreadsheets.
It also provides access to `Pandas`_ DataFrames representing the dataset for use in data analysis.
A collection of utilities for converting `ATT&CK STIX data`_ to Excel spreadsheets.
It also provides access to `Pandas`_ DataFrames representing the dataset for use in data analysis.

Further documentation can be found `here`_.

.. _ATT&CK STIX data: https://github.com/mitre/cti
.. _Pandas: https://pandas.pydata.org/
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/attackToExcel
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/attackToExcel
8 changes: 4 additions & 4 deletions docs/additional_modules/collections.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
collections
==============================================

A set of utilities for working with `ATT&CK Collections and Collection Indexes`_.
Provides functionalities for converting and summarizing data in collections and collection indexes,
A set of utilities for working with `ATT&CK Collections and Collection Indexes`_.
Provides functionalities for converting and summarizing data in collections and collection indexes,
as well as generating a collection from a raw stix bundle input.

Further documentation can be found `here`_.

.. _ATT&CK Collections and Collection Indexes: https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/master/docs/collections.md
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/collections
.. _ATT&CK Collections and Collection Indexes: https://github.com/center-for-threat-informed-defense/attack-workbench-frontend/blob/main/docs/collections.md
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/collections
8 changes: 4 additions & 4 deletions docs/additional_modules/diffStix.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
diffStix
==============================================
Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two
versions of the STIX2 bundles representing the ATT&CK content. Run 'diff_stix -h' for full usage

Create markdown, HTML, JSON and/or ATT&CK Navigator layers reporting on the changes between two
versions of the STIX2 bundles representing the ATT&CK content. Run 'diff_stix -h' for full usage
instructions.

Further documentation can be found `here`_.

.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/diffStix
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/diffStix
8 changes: 4 additions & 4 deletions docs/additional_modules/navlayers.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
navlayers
==============================================

A collection of utilities for working with `ATT&CK Navigator`_ layers.
Provides the ability to import, export, and manipulate layers.
Layers can be read in from the filesystem or python dictionaries, combined and edited,
A collection of utilities for working with `ATT&CK Navigator`_ layers.
Provides the ability to import, export, and manipulate layers.
Layers can be read in from the filesystem or python dictionaries, combined and edited,
and then exported to excel or SVG images.

Further documentation can be found `here`_.

.. _ATT&CK Navigator: https://github.com/mitre-attack/attack-navigator
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/master/mitreattack/navlayers
.. _here: https://github.com/mitre-attack/mitreattack-python/tree/main/mitreattack/navlayers
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Contributing
To contribute to this project, either through a bug report, feature request, or merge request,
please see the `Contributors Guide`_.

.. _Contributors Guide: https://github.com/mitre-attack/mitreattack-python/blob/master/docs/CONTRIBUTING.md
.. _Contributors Guide: https://github.com/mitre-attack/mitreattack-python/blob/main/docs/CONTRIBUTING.md
Loading