Metadata-Version: 2.4
Name: psengine
Version: 2.6.0
Summary: psengine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.
Keywords: API,Recorded Future,Cyber Security Engineering,Threat Intelligence
Author: Moise Medici, Patrick Kinsella, Ernest Bartosevic
Author-email: Moise Medici <moise.medici@recordedfuture.com>, Patrick Kinsella <patrick.kinsella@recordedfuture.com>, Ernest Bartosevic <ernest.bartosevic@recordedfuture.com>
License-Expression: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: typing-extensions>=4.8.0
Requires-Dist: requests>=2.27.1
Requires-Dist: jsonpath-ng>=1.5.3,<=1.6.1
Requires-Dist: stix2~=3.0.1
Requires-Dist: python-dateutil>=2.7.0
Requires-Dist: more-itertools>=9.0.0,<=10.2.0
Requires-Dist: pydantic>=2.7,<3.0.0
Requires-Dist: pydantic-settings[toml]>=2.12.2,<2.13.1
Requires-Dist: markdown-strings==3.4.0
Requires-Python: >=3.10, <3.15
Project-URL: Homepage, https://recordedfuture-professionalservices.github.io/psengine/latest/
Project-URL: Changelog, https://recordedfuture-professionalservices.github.io/psengine/latest/CHANGELOG/
Description-Content-Type: text/markdown

**Documentation**: <https://recordedfuture-professionalservices.github.io/psengine/>

**Github**: <https://github.com/RecordedFuture-ProfessionalServices/psengine>

**PyPi**: <https://pypi.org/project/psengine/>

---

PSEngine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.

PSEngine allows you to interact with the Recorded Future API extremely easily. There’s no need to manually build the URLs and query parameters, just use the modules dedicated to individual API endpoints.

PSEngine is a Python package solely built and maintained by the Recorded Future Cyber Security Engineering team powering a number of high profile integrations, such as: [Banshee](https://recordedfuture-professionalservices.github.io/banshee); [Recorded Future Alerts for QRadar](https://apps.xforce.ibmcloud.com/extension/b36efdf42b7bf5e3759d036dbcdbf606); Anomali ThreatStream: [Alerts](https://support.recordedfuture.com/hc/en-us/articles/29255683708691-Recorded-Future-Alerts-for-Anomali-ThreatStream) and [Analyst Notes](https://support.recordedfuture.com/hc/en-us/articles/12928414947475-Recorded-Future-Analyst-Notes-for-Anomali-ThreatStream) integrations; [Google SecOps](https://app.recordedfuture.com/portal/integration-center/detail/google-chronicle-nbfi?organization=uhash%3A5cJsHMHeSM&filter_tab=all) and many more.


## Installation

PSEngine is a Python package that can be installed using `pip`. To install PSengine, run the following command:

```bash
pip install psengine
```

PSEngine officially supports Python >= 3.10, < 3.15.


## Supported Features & Best Practices

PSEngine is ready for the demands of building robust and reliable integrations.

It can easily interact with the following Recorded Future datasets:

- Analyst Notes
- Attack Surface Intelligence
- Collective Insights
- Classic & Playbook Alerts
- Detection Rules
- Fusion File management
- Identity Exposures management
- List management
- Malware Intelligence (including Auto Yara and Auto Sigma)
- Malware Sandbox reports download
- On demand IOC enrichment
- Risklists
- Risk History
- STIX conversion


And facilitate the development with features like:

- Built-in logging
- Easy configuration management
- Markdown creation from certain data types
- Proxy support

## Previous versions and version documentation

PSEngine has been made public from our internal version 2.0.4. Previous versions, including version 1, are not publicly available.

The documentation arrived at version 2.1.1. Older versions are not explicitly documented and changes can be found in the [Release History](./CHANGELOG.md) section.

