Skip to main content

Python API client for OpenCTI.

Project description

OpenCTI client for Python

Website CircleCI readthedocs GitHub release Number of PyPI downloads Slack Status

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/client-python
$ cd client-python
$ git remote add upstream https://github.com/OpenCTI-Platform/client-python.git
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ 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/

About

OpenCTI is a product designed and developed by the company Filigran.

Project details


Release history Release notifications | RSS feed

This version

6.7.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycti-6.7.3.tar.gz (177.6 kB view details)

Uploaded Source

Built Distribution

pycti-6.7.3-py3-none-any.whl (265.5 kB view details)

Uploaded Python 3

File details

Details for the file pycti-6.7.3.tar.gz.

File metadata

  • Download URL: pycti-6.7.3.tar.gz
  • Upload date:
  • Size: 177.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pycti-6.7.3.tar.gz
Algorithm Hash digest
SHA256 fad8791b2feca6627310e18656e2593a6be3119a53db4d5825b1bbbf0fef542c
MD5 f0c7e9500851c7d5aa43482157c1db2d
BLAKE2b-256 147e6c918e0e72d119b8a8cffedf94ab64c9a288c1acf8eee77ee13171bd7521

See more details on using hashes here.

File details

Details for the file pycti-6.7.3-py3-none-any.whl.

File metadata

  • Download URL: pycti-6.7.3-py3-none-any.whl
  • Upload date:
  • Size: 265.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pycti-6.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2d9d16f02326f9d0c6a46f93e767af066a131226f8ef27a2477b0dcd14aba3d9
MD5 8b602211460fdd5e78d941369cb7066d
BLAKE2b-256 d846c0840d1008c15f157c7fff404e7e3941c7ae927a58aadd9ab558c65696ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page