mirror of
https://github.com/ArcaneChat/core.git
synced 2026-07-03 14:05:33 +02:00
link2xt
30f8522626
To preview the docs, run: ``` scripts/build-python-docs.sh firefox dist/html/index.html ``` I have removed the Makefile because modern Sphinx Makefile is just a wrapper for `sphinx-build -M`: https://github.com/sphinx-doc/sphinx/blob/35965903177c6ed9a6afb62ccd33243a746a3fc0/sphinx/templates/quickstart/Makefile.new_t and sphinx-quickstart even has an option `--no-makefile`. `make.bat` makes even less sense. In `scripts/build-python-docs.sh` I use `sphinx-build` directly without `make` wrapper.
37 lines
1.5 KiB
ReStructuredText
37 lines
1.5 KiB
ReStructuredText
Install
|
||
=======
|
||
|
||
To use JSON-RPC bindings for Delta Chat core you will need
|
||
a ``deltachat-rpc-server`` binary which provides Delta Chat core API over JSON-RPC
|
||
and a ``deltachat-rpc-client`` Python package which is a JSON-RPC client that starts ``deltachat-rpc-server`` process and uses JSON-RPC API.
|
||
|
||
`Create a virtual environment <https://docs.python.org/3/library/venv.html>`__ if you
|
||
don’t have one already and activate it::
|
||
|
||
$ python -m venv venv
|
||
$ . venv/bin/activate
|
||
|
||
Install ``deltachat-rpc-server``
|
||
--------------------------------
|
||
|
||
To get ``deltachat-rpc-server`` binary you have three options:
|
||
|
||
1. Install ``deltachat-rpc-server`` from PyPI using ``pip install deltachat-rpc-server``.
|
||
2. Build and install ``deltachat-rpc-server`` from source with ``cargo install --git https://github.com/deltachat/deltachat-core-rust/ deltachat-rpc-server``.
|
||
3. Download prebuilt release from https://github.com/deltachat/deltachat-core-rust/releases and install it into ``PATH``.
|
||
|
||
Check that ``deltachat-rpc-server`` is installed and can run::
|
||
|
||
$ deltachat-rpc-server --version
|
||
1.131.4
|
||
|
||
Then install ``deltachat-rpc-client`` with ``pip install deltachat-rpc-client``.
|
||
|
||
Install ``deltachat-rpc-client``
|
||
--------------------------------
|
||
|
||
To get ``deltachat-rpc-client`` Python library you can:
|
||
|
||
1. Install ``deltachat-rpc-client`` from PyPI using ``pip install deltachat-rpc-client``.
|
||
2. Install ``deltachat-rpc-client`` from source with ``pip install git+https://github.com/deltachat/deltachat-core-rust.git@main#subdirectory=deltachat-rpc-client``.
|