diff options
| author | Tobias Brunner <tobias@strongswan.org> | 2016-05-11 11:11:44 +0200 |
|---|---|---|
| committer | Tobias Brunner <tobias@strongswan.org> | 2016-05-11 11:16:43 +0200 |
| commit | fa844a798b76b09667cccaa569debd8313949d17 (patch) | |
| tree | 0279185b7c25678546b4b85800a5533f69ed7196 /src | |
| parent | 5d5ecd8e72d173b78424094e71fd0bc1f6e0c929 (diff) | |
| download | strongswan-fa844a798b76b09667cccaa569debd8313949d17.tar.bz2 strongswan-fa844a798b76b09667cccaa569debd8313949d17.tar.xz | |
vici: Add README.rst to be used as description on PyPI
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcharon/plugins/vici/python/MANIFEST.in | 1 | ||||
| -rw-r--r-- | src/libcharon/plugins/vici/python/Makefile.am | 2 | ||||
| -rw-r--r-- | src/libcharon/plugins/vici/python/README.rst | 24 | ||||
| -rw-r--r-- | src/libcharon/plugins/vici/python/setup.py.in | 9 |
4 files changed, 28 insertions, 8 deletions
diff --git a/src/libcharon/plugins/vici/python/MANIFEST.in b/src/libcharon/plugins/vici/python/MANIFEST.in index 1aba38f67..9d5d250d0 100644 --- a/src/libcharon/plugins/vici/python/MANIFEST.in +++ b/src/libcharon/plugins/vici/python/MANIFEST.in @@ -1 +1,2 @@ include LICENSE +include README.rst diff --git a/src/libcharon/plugins/vici/python/Makefile.am b/src/libcharon/plugins/vici/python/Makefile.am index 20d44b5b2..6088200e2 100644 --- a/src/libcharon/plugins/vici/python/Makefile.am +++ b/src/libcharon/plugins/vici/python/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = LICENSE MANIFEST.in \ +EXTRA_DIST = LICENSE README.rst MANIFEST.in \ setup.py.in \ vici/test/__init__.py \ vici/test/test_protocol.py \ diff --git a/src/libcharon/plugins/vici/python/README.rst b/src/libcharon/plugins/vici/python/README.rst new file mode 100644 index 000000000..3990f6300 --- /dev/null +++ b/src/libcharon/plugins/vici/python/README.rst @@ -0,0 +1,24 @@ +About +----- + +The strongSwan VICI protocol allows external applications to monitor, configure +and control the IKE daemon charon. This Python package provides a native client +side implementation of the VICI protocol, well suited to script automated tasks +in a reliable way. + + +Example Usage +------------- + +.. code-block:: python + + >>> import vici + >>> s = vici.Session() + >>> s.version() + OrderedDict([('daemon', b'charon'), ('version', b'5.4.0'), + ('sysname', b'Linux'), ('release', b'3.13.0-27-generic'), ('machine', b'x86_64')]) + >>> s.load_pool({"p1": {"addrs": "10.0.0.0/24"}}) + OrderedDict([('success', b'yes')]) + >>> s.get_pools() + OrderedDict([('p1', OrderedDict([('base', b'10.0.0.0'), ('size', b'254'), + ('online', b'0'), ('offline', b'0')]))]) diff --git a/src/libcharon/plugins/vici/python/setup.py.in b/src/libcharon/plugins/vici/python/setup.py.in index 0e2bf0d55..62b0c5899 100644 --- a/src/libcharon/plugins/vici/python/setup.py.in +++ b/src/libcharon/plugins/vici/python/setup.py.in @@ -1,12 +1,7 @@ from setuptools import setup - -long_description = ( - "The strongSwan VICI protocol allows external application to monitor, " - "configure and control the IKE daemon charon. This python package provides " - "a native client side implementation of the VICI protocol, well suited to " - "script automated tasks in a reliable way." -) +with open('README.rst') as file: + long_description = file.read() setup( name="vici", |