File: README.md

package info (click to toggle)
python-proton-vpn-local-agent 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 496 kB
  • sloc: python: 380; makefile: 36; sh: 12
file content (35 lines) | stat: -rw-r--r-- 930 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# What is this?
This repo contains a rust crate for communicating with a proton LocalAgent,
server, and python bindings for that crate.

## From github

> cd python-proton-vpn-local-agent
> cargo build --release
> mv target/release/libpython_proton_vpn_local_agent.so local_agent.so

The local_agent.so file is your python module.


## Internally on x86

From the root.

> ci-libraries-rust/scripts/build-python-extension x86_64-unknown-linux-gnu && ci-libraries-rust/scripts/build-wheel

That builds the python module.

Install local_agent to your venv with
> pip install python-proton-vpn-local-agent/target/*.whl

Now you're away.

```python
import proton.vpn.local_agent as local_agent
connection = local_agent.AgentConnector().connect("localhost", key, certificate)
```

# Repo structure.
The repo is split into 2 projects, these are:
- local_agent_rs : The rust library
- python-proton-vpn-local-agent : The python bindings