vici: Add README.rst to be used as description on PyPI
This commit is contained in:
@@ -1 +1,2 @@
|
|||||||
include LICENSE
|
include LICENSE
|
||||||
|
include README.rst
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
EXTRA_DIST = LICENSE MANIFEST.in \
|
EXTRA_DIST = LICENSE README.rst MANIFEST.in \
|
||||||
setup.py.in \
|
setup.py.in \
|
||||||
vici/test/__init__.py \
|
vici/test/__init__.py \
|
||||||
vici/test/test_protocol.py \
|
vici/test/test_protocol.py \
|
||||||
|
|||||||
@@ -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')]))])
|
||||||
@@ -1,12 +1,7 @@
|
|||||||
from setuptools import setup
|
from setuptools import setup
|
||||||
|
|
||||||
|
with open('README.rst') as file:
|
||||||
long_description = (
|
long_description = file.read()
|
||||||
"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."
|
|
||||||
)
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="vici",
|
name="vici",
|
||||||
|
|||||||
Reference in New Issue
Block a user