OpenCTI client for Python
The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils. This client is also used by some OpenCTI components.
Install
To install the latest Python client library, please use pip:
$ pip3 install pycti
Local development
# Fork the current repository, then clone your fork
$ git clone https://github.com/YOUR-USERNAME/opencti.git
$ cd client-python
$ git remote add upstream https://github.com/OpenCTI-Platform/opencti.git
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ cd client-python
$ python3 -m venv .venv
$ source .venv/bin/activate
# Install the client-python and dependencies for the development and the documentation
$ python3 -m pip install -e .[dev,doc]
# Set up the git hook scripts
$ pre-commit install
# Create your feature/fix
# Create tests for your changes
$ pytest
# Push you feature/fix on Github
$ git add [file(s)]
$ git commit -m "[descriptive message]"
$ git push origin [branch-name]
# Open a pull request
Install the package locally
$ pip install -e .
Documentation
Client usage
To learn about how to use the OpenCTI Python client and read some examples and cases, refer to the client documentation.
API reference
To learn about the methods available for executing queries and retrieving their answers, refer to the client API Reference.
Tests
Install dependencies
$ pip install -r ./test-requirements.txt
pytest is used to launch the tests.
Launch tests
Prerequisite
Your OpenCTI API should be running. Your conftest.py should be configured with your API url, your token, and if applicable, your mTLS cert/key.
Launching
Unit tests
$ pytest ./tests/01-unit/
Integration testing
$ pytest ./tests/02-integration/
Example testing:
OpenCTI must be running
cd examples
# Configure with you local instance of OpenCTI
export OPENCTI_API_URL="http://localhost:4000"
export OPENCTI_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxx"
#Run one example file
python get_indicators_of_malware.py
About
OpenCTI is a product designed and developed by the company Filigran.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pycti-7.260817.0.tar.gz.
File metadata
- Download URL: pycti-7.260817.0.tar.gz
- Upload date:
- Size: 265.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a192cd8c78f534b61eedbd025320286c5d3a7b529603e862ab3580fbe0227ff1
|
|
| MD5 |
d9ff5fdd9913bfd06e15c79e1bf5d614
|
|
| BLAKE2b-256 |
79a83cfe27f79ad64a21964aa096b287c813f11f1af5333e404b650963611f64
|
File details
Details for the file pycti-7.260817.0-py3-none-any.whl.
File metadata
- Download URL: pycti-7.260817.0-py3-none-any.whl
- Upload date:
- Size: 355.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe7172964e9c1469f836b59cb2bd1da29235889dc5029105eadf5b50c6d6a5ce
|
|
| MD5 |
5b1010f59cd5807e28f45ee3176ca67e
|
|
| BLAKE2b-256 |
bf6f9c03e88529bfcb463595978a116367e9104a41ac0adcdc5db092775bb745
|
