Skip to content
This repository was archived by the owner on Dec 5, 2025. It is now read-only.

Commit 23c3cb8

Browse files
committed
Add docs from notion
1 parent 140aee8 commit 23c3cb8

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55
[![GitHub release](https://img.shields.io/github/release/OpenCTI-Platform/client-python.svg)](https://github.com/OpenCTI-Platform/client-python/releases/latest)
66
[![Number of PyPI downloads](https://img.shields.io/pypi/dm/pycti.svg)](https://pypi.python.org/pypi/pycti/)
77
[![Slack Status](https://slack.luatix.org/badge.svg)](https://slack.luatix.org)
8+
[![readthedocs](https://readthedocs.org/projects/opencti-client-for-python/badge/?style=flat)](https://opencti-client-for-python.readthedocs.io/en/latest/)
89

9-
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.
10+
The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils.
11+
This client is also used by some OpenCTI components.
1012

11-
## Python client
13+
## Install
1214

13-
To install the Python client library, please use `pip`:
15+
To install the latest Python client library, please use `pip`:
1416

1517
```bash
1618
$ pip3 install pycti
@@ -20,11 +22,11 @@ $ pip3 install pycti
2022

2123
### Client usage
2224

23-
To learn about how to use the OpenCTI Python client and read some examples and cases, refer to [the client documentation](https://www.notion.so/luatix/Python-8adaac485c88475a8f465f99a73892b3).
25+
To learn about how to use the OpenCTI Python client and read some examples and cases, refer to [the client documentation](https://opencti-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).
2426

2527
### API reference
2628

27-
To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://www.notion.so/luatix/Client-API-Reference-efeeb6deed74452fbf4d328017959d62).
29+
To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://opencti-client-for-python.readthedocs.io/en/latest/modules/modules.html).
2830

2931
## About
3032

docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
OpenCTI client for Python
22
=========================
33

4+
The pycti library is designed to help OpenCTI users and developers to interact
5+
with the OpenCTI platform GraphQL API.
6+
7+
The Python library requires Python >= 3.
8+
49
.. toctree::
510
:maxdepth: 2
611
:caption: Contents:
712

813
modules/modules.rst
14+
client_usage/getting_started.rst
915

1016
Indices and tables
1117
==================

0 commit comments

Comments
 (0)