summaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 16538d9c78065899a9b4db99ce8e07f30fe41103 (plain)
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
===========
TTUN Client
===========

|Deploy|

.. |Deploy| image:: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml/badge.svg
   :target: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml

Expose a localport via you selfhosted `TTUN Server <https://github.com/tomvanderlee/ttun-server>`_

Installing
----------

::

    pip install ttun

Developing
----------

1. Create and activate a python 3.10 virtual environment

2. Install requirements::

    pip install -r requirements.txt

3. Run::

    python -m ttun