Skip to content

Commit

Permalink
Required Python version -> 3.7, fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
jshcodes committed May 13, 2022
1 parent 12f5c69 commit 6ab0a35
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,27 @@

A friendly wrapper to help you interact with the CrowdStrike Falcon API. Less code, less fuss, better performance, and full interoperability with [FalconPy](https://github.com/CrowdStrike/falconpy/).

- [Features](#features)
- [Installation](#installation-instructions)
- [Basic Usage](#basic-usage-example)
- [Examples](#examples-collection)
- [Documentation](#documentation)
- [Contributing](#contributing)


## Features
A few of the developer experience enhancements provided by the Caracara toolkit include:
| Feature | Details |
| :--- | :--- |
| __Automatic pagination with concurrency__ | Caracara will handle all request pagination for you, so you do not have to think about things like batch sizes, batch tokens or parallelisation. Caracara will even multithread batch data retrieval requests where possible, hugely increasing data retrieval times for large datasets such as host lists. |
| __Friendly to your IDE (and you!)__ | Caracara is written with full support for IDE autocomplete in mind. We have tested autocomplete in Visual Studio Code and PyCharm, and will accept issues and patches for more IDE support where needed. Furthermore, all code, where possible, is written with type hints so you can be confident in parameters and return values. |
| __Logging__ | Caracara is built with the in-box `logging` library provided with Python 3. Simply set up your logging handlers in your main code file, and Caracara will forward over `debug`, `info` and `error` logs as they are produced. Note that the `debug` logs are very verbose, and we recommend writing these outputs to file as opposed to the console when retrieving large amounts of lightly filtered data. |
| __Real Time Response (RTR) batch session abstraction__ | Caracara provides a rich interface to RTR session batching, allowing you to connect to as many hosts as possible. Want to download a specific file from every system in your Falcon tenant? Caracara will even extract it from the `.7z` container for you. |
| __Rich and detailed sample code__ | Every module of Caracara comes bundled with executable, fully configurable code samples that address frequent use cases. All samples are built around a common strcuture allowing for code reuse and easy reading. Just add your API credentials to `config.yml`, and all samples will be ready to go. |
| __Simple filter syntax__ | Caracara provides an object-orientated Falcon Query Language (FQL) generator. The `FalconFilter` object lets you specify filters such as `Hostname`, `OS` and `Role`, which get automatically converted to valid FQL. Never write an FQL filter yourself again! |
| __Single authentication point of entry__ | Authenticate once and have access to every module. |
| __100% FalconPy compatibility__ | Caracara is built on FalconPy, and can even be configured with a FalconPy `OAuth2` object via the `auth_object` constructor parameter, allowing you to reuse FalconPy authentication objects across Caracara and FalconPy. Authenticate once with FalconPy, and access every feature of FalconPy and Caracara. |

## Installation Instructions

Caracara supports all major Python packaging solutions. Instructions for [Poetry](https://python-poetry.org) and [Pip](https://pypi.org/project/pip/) are provided below.
Expand Down Expand Up @@ -126,3 +147,11 @@ poetry run examples/get_devices/list_windows_devices.py
```

</details>

## Documentation
__*Coming soon!*__



## Contributing
Interested in taking part in the development of the Caracara project? Start [here](CONTRIBUTING.md).
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Security Policy
This document outlines security policy and procedures for the CrowdStrike `falconpy-tools` project.
+ [Supported Python versions](#supported-python-versions)
+ [Supported FalconPy Tools versions](#supported-falconpy-tools-versions)
+ [Supported Caracara versions](#supported-caracara-versions)
+ [Reporting a potential security vulnerability](#reporting-a-potential-security-vulnerability)
+ [Disclosure and Mitigation Process](#disclosure-and-mitigation-process)

Expand All @@ -11,11 +11,11 @@ FalconPy functionality is unit tested to run under the following versions of Pyt

| Version | Supported |
| :------- | :--------- |
| 3.10.x | :white_check_mark: |
| 3.9.x | :white_check_mark: |
| 3.8.x | :white_check_mark: |
| 3.7.x | :white_check_mark: |
| 3.6.x | :white_check_mark: |
| <= 3.5 | :x: |
| <= 3.6.x | :x: |
| <= 2.x.x | :x: |

This unit testing is performed using Windows, MacOS, and Ubuntu Linux.
Expand Down

0 comments on commit 6ab0a35

Please sign in to comment.