[client] Enhance docs

README.md

@@ -5,4 +5,92 @@
 [![readthedocs](https://readthedocs.org/projects/openbas-client-for-python/badge/?style=flat)](https://openbas-client-for-python.readthedocs.io/en/latest/)
 [![GitHub release](https://img.shields.io/github/release/OpenBAS-Platform/client-python.svg)](https://github.com/OpenBAS-Platform/client-python/releases/latest)
 [![Number of PyPI downloads](https://img.shields.io/pypi/dm/pyobas.svg)](https://pypi.python.org/pypi/pyobas/)
-[![Slack Status](https://img.shields.io/badge/slack-3K%2B%20members-4A154B)](https://community.filigran.io)
+[![Slack Status](https://img.shields.io/badge/slack-3K%2B%20members-4A154B)](https://community.filigran.io)
+
+The official OpenBAS Python client helps developers to use the OpenBAS API by providing easy to use methods and utils.
+This client is also used by some OpenBAS components.
+
+## Install
+
+To install the latest Python client library, please use `pip`:
+
+```bash
+$ pip3 install pyobas
+```
+
+## Local development
+
+```bash
+# 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/OpenBAS-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
+
+```bash
+$ pip install -e .
+```
+
+## Documentation
+
+### Client usage
+
+To learn about how to use the OpenBAS Python client and read some examples and cases, refer to [the client documentation](https://openbas-client-for-python.readthedocs.io/en/latest/client_usage/getting_started.html).
+
+### API reference
+
+To learn about the methods available for executing queries and retrieving their answers, refer to [the client API Reference](https://openbas-client-for-python.readthedocs.io/en/latest/pyobas/pyobas.html).
+
+## Tests
+
+### Install dependencies
+
+```bash
+$ pip install -r ./test-requirements.txt
+```
+
+[pytest](https://docs.pytest.org/en/7.2.x/) is used to launch the tests.
+
+### Launch tests
+
+#### Prerequisite
+
+Your OpenBAS 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
+```bash
+$ pytest ./tests/01-unit/
+```
+
+Integration testing
+```bash
+$ pytest ./tests/02-integration/
+```
+
+## About
+
+OpenBAS is a product designed and developed by the company [Filigran](https://filigran.io).
+
+<a href="https://filigran.io" alt="Filigran"><img src="https://github.com/OpenBAS-Platform/openbas/raw/master/.github/img/logo_filigran.png" width="300" /></a>

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/client_usage/getting_started.rst

@@ -0,0 +1,12 @@
+Getting Started
+===============
+
+Installation
+************
+
+Please install the latest pycti version available from PyPI::
+
+    $ pip3 install pyobas
+
+Using the helper functions
+**************************

docs/conf.py

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "OpenCTI client for Python"
+copyright = "2024, Filigran"
+author = "OpenCTI Project"
+
+# The full version, including alpha/beta/rc tags
+release = "5.12.20"
+
+master_doc = "index"
+
+autoapi_modules = {"pyobas": {"prune": True}}
+
+pygments_style = "sphinx"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.inheritance_diagram",
+    "autoapi.sphinx",
+    "sphinx_autodoc_typehints",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/index.rst

@@ -0,0 +1,22 @@
+OpenBAS client for Python
+=========================
+
+The pycti library is designed to help OpenBAS users and developers to interact
+with the OpenBAS platform GraphQL API.
+
+The Python library requires Python >= 3.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   client_usage/getting_started.rst
+   pycti/pycti
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,4 @@
+autoapi==2.0.1
+sphinx==7.2.6
+sphinx-autodoc-typehints==2.0.0
+sphinx_rtd_theme==2.0.0