Panther Core

Python core for Panther detections

Documentation | Quick Start

panther_core is a Python library for Panther Detections. See the Panther documentation for more details on Panther.

Installation

Install simply with pip:

$ pip3 install panther_core

Build From Source

If you'd prefer instead to run from source for development reasons, first setup your environment:

$ make install
$ pipenv run -- pip3 install -e .

If you would rather use the panther_core outside of the virtual environment, install it directly:

$ make deps
$ pip3 install -e .

Publishing

Update the version in setup.py in a pull request and merge. After the merge, setup a GitHub release with the appropriate release and tag with the format vX.X.X. Once this is done, run the following on the main branch:

$ make publish

Contributing

We welcome all contributions! Please read the contributing guidelines before submitting pull requests. Instructions for opening a pull request from your fork of the repo can be found on Github.

License

This repository is licensed under the AGPL-3.0 license.