vici: Add README.rst to be used as description on PyPI
authorTobias Brunner <tobias@strongswan.org>
Wed, 11 May 2016 09:11:44 +0000 (11:11 +0200)
committerTobias Brunner <tobias@strongswan.org>
Wed, 11 May 2016 09:16:43 +0000 (11:16 +0200)
src/libcharon/plugins/vici/python/MANIFEST.in
src/libcharon/plugins/vici/python/Makefile.am
src/libcharon/plugins/vici/python/README.rst [new file with mode: 0644]
src/libcharon/plugins/vici/python/setup.py.in

index 20d44b5..6088200 100644 (file)
@@ -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 (file)
index 0000000..3990f63
--- /dev/null
@@ -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')]))])
index 0e2bf0d..62b0c58 100644 (file)
@@ -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",