panther_analysis_tool 1.0.0__tar.gz

panther_analysis_tool-1.0.0/LICENSE.txt

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with such entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include Communication related to the current
+      License).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, distribute, prepare
+      Derivative Works of, and publicly perform and display the Work and such
+      Derivative Works in all media and formats whether now known or
+      hereafter devised.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   7. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   8. Accepting Warranty or Support. You may choose to offer, and to
+      charge a fee for, warranty, support, indemnity or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and on
+      Your sole responsibility, not on behalf of any other Contributor, and
+      only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or support.
+
+   9. Acceptance and Termination. Nothing in this License shall be deemed
+      to create any relationship of agency, partnership, or joint venture
+      between Licensor and You. This License does not grant permission to
+      use the trade names, trademarks, service marks, or product names of the
+      Licensor, except as required for reasonable and customary use in
+      describing the origin of the Work and reproducing the content of
+      the NOTICE file.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

panther_analysis_tool-1.0.0/PKG-INFO

@@ -0,0 +1,420 @@
+Metadata-Version: 2.3
+Name: panther_analysis_tool
+Version: 1.0.0
+Summary: Panther command line interface for writing, testing, and packaging policies/rules.
+License: Apache-2.0
+Keywords: Security,CLI
+Author: Panther Labs Inc
+Author-email: pypi@runpanther.io
+Requires-Python: >=3.11, <4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Security
+Requires-Dist: aiohappyeyeballs (==2.4.6)
+Requires-Dist: aiohttp (==3.11.12)
+Requires-Dist: aiosignal (==1.3.2)
+Requires-Dist: anyio (==4.8.0)
+Requires-Dist: appdirs (==1.4.4)
+Requires-Dist: async-timeout (==5.0.1)
+Requires-Dist: attrs (==25.1.0)
+Requires-Dist: backoff (==2.2.1)
+Requires-Dist: boto3 (==1.28.44)
+Requires-Dist: botocore (==1.31.44)
+Requires-Dist: certifi (==2024.7.4)
+Requires-Dist: chardet (==5.2.0)
+Requires-Dist: charset-normalizer (==3.4.1)
+Requires-Dist: click (==8.1.8)
+Requires-Dist: colorama (==0.4.6)
+Requires-Dist: contextlib2 (==21.6.0)
+Requires-Dist: decorator (==5.1.1)
+Requires-Dist: diff-cover (==9.2.0)
+Requires-Dist: dill (==0.3.7)
+Requires-Dist: dynaconf (==3.2.2)
+Requires-Dist: exceptiongroup (==1.2.2)
+Requires-Dist: frozenlist (==1.5.0)
+Requires-Dist: gql[aiohttp] (==3.5.0)
+Requires-Dist: graphql-core (==3.2.3)
+Requires-Dist: idna (==3.7)
+Requires-Dist: iniconfig (==2.0.0)
+Requires-Dist: jinja2 (==3.1.6)
+Requires-Dist: jmespath (==1.0.1)
+Requires-Dist: jsonlines (==4.0.0)
+Requires-Dist: jsonpath-ng (==1.5.3)
+Requires-Dist: jsonschema (==4.23.0)
+Requires-Dist: jsonschema-specifications (==2024.10.1)
+Requires-Dist: markupsafe (==3.0.2)
+Requires-Dist: multidict (==6.1.0)
+Requires-Dist: nested-lookup (==0.2.25)
+Requires-Dist: packaging (==23.1)
+Requires-Dist: panther-core (==0.12.1)
+Requires-Dist: pathspec (==0.12.1)
+Requires-Dist: pluggy (==1.5.0)
+Requires-Dist: ply (==3.11)
+Requires-Dist: policyuniverse (==1.5.1.20230817)
+Requires-Dist: propcache (==0.2.1)
+Requires-Dist: pygments (==2.19.1)
+Requires-Dist: pytest (==8.3.4)
+Requires-Dist: python-dateutil (==2.8.2)
+Requires-Dist: pyyaml (==6.0.2)
+Requires-Dist: referencing (==0.36.2)
+Requires-Dist: regex (==2024.11.6)
+Requires-Dist: requests (==2.32.4)
+Requires-Dist: rpds-py (==0.22.3)
+Requires-Dist: ruamel-yaml (==0.17.32)
+Requires-Dist: ruamel-yaml-clib (==0.2.7)
+Requires-Dist: s3transfer (==0.6.2)
+Requires-Dist: schema (==0.7.5)
+Requires-Dist: semver (==2.13.0)
+Requires-Dist: setuptools (>=78.1.1)
+Requires-Dist: six (==1.16.0)
+Requires-Dist: sniffio (==1.3.1)
+Requires-Dist: sqlfluff (==2.3.1)
+Requires-Dist: tblib (==3.0.0)
+Requires-Dist: toml (==0.10.2)
+Requires-Dist: tomli (==2.2.1)
+Requires-Dist: tqdm (==4.67.1)
+Requires-Dist: typing-extensions (==4.7.1)
+Requires-Dist: urllib3 (==1.26.19)
+Requires-Dist: wrapt (==1.15.0)
+Requires-Dist: yarl (==1.18.3)
+Project-URL: Downloads, https://github.com/panther-labs/panther_analysis_tool/archive/v1.0.0.tar.gz
+Project-URL: Homepage, https://github.com/panther-labs/panther_analysis_tool
+Description-Content-Type: text/markdown
+
+# Panther Analysis Tool
+
+[Panther Analysis Tool](https://github.com/panther-labs/panther_analysis_tool)
+is a Python application for testing, packaging, and deploying Panther
+Detections.
+
+For further details, see [Quick Start](https://docs.panther.com/quick-start) and
+[Panther Documentation](https://docs.panther.com/).
+
+## Installation
+
+### From PyPi
+
+Use pip to install
+[panther_analysis_tool package](https://pypi.org/project/panther-analysis-tool/)
+from PyPi:
+
+```shell
+pip3 install panther_analysis_tool
+```
+
+Or without a virtual environment:
+
+```shell
+make deps
+pip3 install -e .
+```
+
+### From source
+
+```shell
+make install
+pipenv run -- pip3 install -e .
+```
+
+## Usage
+
+### Help
+
+Show available commands and their options:
+
+```bash
+$ panther_analysis_tool -h
+usage: panther_analysis_tool [-h] [--version] [--debug] [--skip-version-check] {release,test,publish,upload,delete,update-custom-schemas,test-lookup-table,validate,zip,check-connection,benchmark,enrich-test-data} ...
+
+Panther Analysis Tool: A command line tool for managing Panther policies and rules.
+
+positional arguments:
+  {release,test,publish,upload,delete,update-custom-schemas,test-lookup-table,validate,zip,check-connection,benchmark,enrich-test-data}
+    release             Create release assets for repository containing panther detections. Generates a file called panther-analysis-all.zip and optionally generates panther-analysis-all.sig
+    test                Validate analysis specifications and run policy and rule tests.
+    publish             Publishes a new release, generates the release assets, and uploads them. Generates a file called panther-analysis-all.zip and optionally generates panther-analysis-all.sig
+    upload              Upload specified policies and rules to a Panther deployment.
+    delete              Delete policies, rules, or saved queries from a Panther deployment
+    update-custom-schemas
+                        Update or create custom schemas on a Panther deployment.
+    test-lookup-table   Validate a Lookup Table spec file.
+    validate            Validate your bulk uploads against your panther instance
+    zip                 Create an archive of local policies and rules for uploading to Panther.
+    check-connection    Check your Panther API connection
+    benchmark           Performance test one rule against one of its log types. The rule must be the only item in the working directory or specified by --path, --ignore-files, and --filter. This feature is an extension
+                        of Data Replay and is subject to the same limitations.
+    enrich-test-data    Enrich test data with additional enrichments from the Panther API.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --version             show program's version number and exit
+  --debug
+  --skip-version-check
+```
+
+### Test
+
+Run tests for a given path:
+
+```bash
+$ panther_analysis_tool test --path tests/fixtures/valid_policies/
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies/
+
+AWS.IAM.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+```
+
+Run a specific unit test of a rule:
+
+```bash
+$ panther_analysis_tool test --filter RuleID=AWS.IAM.AccessKeyCompromised --test-names "An AWS Access Key was Uploaded to Github"
+[INFO]: Testing analysis items in .
+
+AWS.IAM.AccessKeyCompromised
+        [PASS] An AWS Access Key was Uploaded to Github
+```
+
+Run specific unit tests of a rule:
+
+```bash
+$ panther_analysis_tool test --filter RuleID=AWS.CloudTrail.Stopped --test-names "CloudTrail Was Stopped" "Error Stopping CloudTrail"
+[INFO]: Testing analysis items in .
+
+        [PASS] CloudTrail Was Stopped
+        ...
+        [PASS] Error Stopping CloudTrail
+                [PASS] [rule] false
+```
+
+
+### Upload
+
+Create packages to upload through the Panther UI:
+
+```bash
+$ panther_analysis_tool zip --path tests/fixtures/valid_policies/ --out tmp
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies/
+
+AWS.IAM.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+
+[INFO]: Zipping analysis packs in tests/fixtures/valid_policies/ to tmp
+[INFO]: <current working directory>/tmp/panther-analysis-2020-03-23T12-48-18.zip
+```
+
+Or upload packages directly into Panther:
+
+```bash
+$ panther_analysis_tool upload --path tests/fixtures/valid_policies/ --out tmp
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies/
+
+AWS.IAM.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+
+AWS.IAM.BetaTest
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+
+AWS.CloudTrail.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+
+[INFO]: Zipping analysis packs in tests/fixtures/valid_policies/ to tmp
+[INFO]: Found credentials in environment variables.
+[INFO]: Uploading pack to Panther
+[INFO]: Upload success.
+[INFO]: API Response:
+{
+  "modifiedPolicies": 0,
+  "modifiedRules": 0,
+  "newPolicies": 2,
+  "newRules": 1,
+  "totalPolicies": 2,
+  "totalRules": 1
+}
+```
+
+### Filtering
+
+The `test`, `zip`, and `upload` commands all support filtering. Filtering works
+by passing the `--filter` argument with a list of filters specified in the
+format `KEY=VALUE1,VALUE2`. The keys can be any valid field in a policy or rule.
+When using a filter, only anaylsis that matches each filter specified will be
+considered. For example, the following command will test only items with the
+AnalysisType as `policy` AND severity as `High`:
+
+```bash
+$ panther_analysis_tool test --path tests/fixtures/valid_policies --filter AnalysisType=policy Severity=High
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies
+
+AWS.IAM.BetaTest
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+```
+
+Alternately, the following command will test items with the AnalysisType
+`policy` OR `rule`, AND the severity `High`:
+
+```bash
+$ panther_analysis_tool test --path tests/fixtures/valid_policies --filter AnalysisType=policy,rule Severity=High
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies
+
+AWS.IAM.BetaTest
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+
+AWS.CloudTrail.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+```
+
+When writing policies or rules that refer to the global analysis types, include
+them in the filter. An empty string as a filter value means the filter applies
+only if the field exists. The following command returns an error: the policy
+imports a global, but the global lacks a severity and thus is excluded by the
+filter.
+
+```bash
+$ panther_analysis_tool test --path tests/fixtures/valid_policies --filter AnalysisType=policy,global Severity=Critical
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies
+
+AWS.IAM.MFAEnabled
+    [ERROR] Error loading module, skipping
+
+Invalid: tests/fixtures/valid_policies/example_policy.yml
+    No module named 'panther'
+
+[ERROR]: [('tests/fixtures/valid_policies/example_policy.yml', ModuleNotFoundError("No module named 'panther'"))]
+```
+
+For this query to work, allow for the abscence of the severity field:
+
+```bash
+$ panther_analysis_tool test --path tests/fixtures/valid_policies --filter AnalysisType=policy,global Severity=Critical,""
+[INFO]: Testing analysis packs in tests/fixtures/valid_policies
+
+AWS.IAM.MFAEnabled
+    [PASS] Root MFA not enabled fails compliance
+    [PASS] User MFA not enabled fails compliance
+```
+
+Filters work for the `zip` and `upload` commands in the exact same way they work
+for the `test` command.
+
+In addition to filtering, setting a minimum number of unit tests is possible
+with the --minimum-tests flag. Detections lacking the minimum number of tests
+are considered failing. If `--minimum-tests` is set to 2 or greater, the
+requirement becomes that at least one test must return `True` and another must
+return `False`.
+
+```
+$ panther_analysis_tool test --path tests/fixtures/valid_policies --minimum-tests 2
+% panther_analysis_tool test --path okta_rules --minimum-tests 2
+[INFO]: Testing analysis packs in okta_rules
+
+Okta.AdminRoleAssigned
+    [PASS] Admin Access Assigned
+
+Okta.BruteForceLogins
+    [PASS] Failed login
+
+Okta.GeographicallyImprobableAccess
+    [PASS] Non Login
+    [PASS] Failed Login
+
+--------------------------
+Panther CLI Test Summary
+    Path: okta_rules
+    Passed: 0
+    Failed: 3
+    Invalid: 0
+
+--------------------------
+Failed Tests Summary
+    Okta.AdminRoleAssigned
+         ['Insufficient test coverage, 2 tests required but only 1 found.', 'Insufficient test coverage: expected at least one passing and one failing test.']
+
+    Okta.BruteForceLogins
+        ['Insufficient test coverage, 2 tests required but only 1 found.', 'Insufficient test coverage: expected at least one passing and one failing test]
+
+    Okta.GeographicallyImprobableAccess
+        ['Insufficient test coverage: expected at least one passing and one failing test.']
+```
+
+In this case, even though the rules passed all their tests, they are still
+considered failing because they do not have the correct test coverage.
+
+### Delete Rules, Policies, or Saved Queries
+
+```bash
+$ panther_analysis_tool delete
+
+usage: panther_analysis_tool delete [-h] [--no-confirm] [--athena-datalake] [--api-token API_TOKEN] [--api-host API_HOST] [--aws-profile AWS_PROFILE] [--analysis-id ANALYSIS_ID [ANALYSIS_ID ...]]
+                                    [--query-id QUERY_ID [QUERY_ID ...]]
+
+Delete policies, rules, or saved queries from a Panther deployment
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --no-confirm          Skip manual confirmation of deletion (default: False)
+  --athena-datalake     Instance DataLake is backed by Athena (default: False)
+  --api-token API_TOKEN
+                        The Panther API token to use. See: https://docs.panther.com/api-beta (default: None)
+  --api-host API_HOST   The Panther API host to use. See: https://docs.panther.com/api-beta (default: None)
+  --aws-profile AWS_PROFILE
+                        The AWS profile to use when updating the AWS Panther deployment. (default: None)
+  --analysis-id ANALYSIS_ID [ANALYSIS_ID ...]
+                        Space separated list of Detection IDs (default: [])
+  --query-id QUERY_ID [QUERY_ID ...]
+                        Space separated list of Saved Queries (default: [])
+```
+
+Pass a space-separated list of Analysis IDs (RuleID or PolicyID) or QueryIDs.
+Use the --no-confirm flag to bypass confirmation prompts. Rules and their
+associated saved queries will be matched and deleted. The default configuration
+targets a Snowflake datalake; for an Athena datalake, use the --athena-datalake
+flag.
+
+## Configuration File
+
+Panther Analysis Tool will also read options from a configuration file
+`.panther_settings.yml` in the current working directory. An example
+configuration file is included in this repo,
+[example_panther_config.yml](example_panther_config.yml), that contains example
+syntax for supported options.
+
+Options in the configuration file take precedence over command-line options. For
+instance, if minimum_tests: 2 is set in the configuration file and
+--minimum-tests 1 is specified on the command line, the minimum number of tests
+will be 2.
+
+## Contributing
+
+All contributions are welcome. Prior to submitting pull requests, consult the
+[contributing guidelines](https://github.com/panther-labs/panther-analysis/blob/master/CONTRIBUTING.md).
+For steps to open a pull request from a fork, refer to
+[GitHub's guide](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+### Local Development
+
+To develop with the panther_analysis_tool locally, prepare two repositories:
+this one and another containing the panther analysis content for PAT testing.
+
+From your [panther_analysis](https://github.com/panther-labs/panther-analysis)
+content repository, install as editable (and test, for example):
+
+```bash
+pipenv install --editable ../relative/path/to/panther_analysis_tool
+pipenv run panther_analysis_tool test
+```
+
+## License
+
+This repository is licensed under the AGPL-3.0
+[license](https://github.com/panther-labs/panther-analysis/blob/master/LICENSE).
+