Better reStructuredText
This commit is contained in:
parent
1ac8a3b757
commit
9bff8b8b62
17
README.rst
17
README.rst
@ -1,16 +1,18 @@
|
||||
=========================
|
||||
Python Sympa SOAP Wrapper
|
||||
=========================
|
||||
|
||||
Small wrapper that uses [ZEEP](https://pypi.org/project/zeep/) to communicate with a SOAP endpoint linked to a Sympa
|
||||
Small wrapper that uses `ZEEP <https://pypi.org/project/zeep/>`_ to communicate with a SOAP endpoint linked to a Sympa
|
||||
server, to let automation in lists creation.
|
||||
|
||||
Example
|
||||
-------
|
||||
=======
|
||||
|
||||
Start by creating a new client, and log in.
|
||||
Then, you can use some pre-constructed methods.
|
||||
|
||||
```python
|
||||
.. code-block:: python
|
||||
|
||||
from sympasoap import Client
|
||||
|
||||
client = Client("https://lists.example.com/sympa")
|
||||
@ -26,12 +28,13 @@ client.subscribe(email="toto@example.com", list_address="automatically-created",
|
||||
|
||||
# Unsubscribe the email in quiet mode
|
||||
client.subscribe(email="toto@example.com", list_address="automatically-created", quiet=True)
|
||||
```
|
||||
|
||||
|
||||
Available functions
|
||||
-------------------
|
||||
===================
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
```python
|
||||
def login(self, email: str, password: str) -> None:
|
||||
"""
|
||||
Login into the API. Set a cookie for future connexions.
|
||||
@ -91,4 +94,4 @@ Available functions
|
||||
Subscribe the user with the given email to the given mailing list.
|
||||
If the quiet mode is enabled, the user won't receive a notification that they got subscribed.
|
||||
"""
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user