diff options
| author | Thibaut Horel <thibaut.horel@gmail.com> | 2013-04-16 23:46:01 +0200 |
|---|---|---|
| committer | Thibaut Horel <thibaut.horel@gmail.com> | 2013-04-16 23:46:01 +0200 |
| commit | 4b0ace13acc7d123b238b1a910ed0fe40a391668 (patch) | |
| tree | 4da66ec20545beaf39bf9c4b9b5cfd807b08bd50 | |
| parent | 7adcac4cf9e86fed4aa9f91631544d7e5bce48a7 (diff) | |
| download | python-pushover-4b0ace13acc7d123b238b1a910ed0fe40a391668.tar.gz | |
Restructure the documentation
| -rw-r--r-- | README.rst | 29 | ||||
| -rw-r--r-- | doc/index.rst | 23 | ||||
| -rw-r--r-- | pushover.py | 5 |
3 files changed, 50 insertions, 7 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..44eff08 --- /dev/null +++ b/README.rst @@ -0,0 +1,29 @@ +Python-pushover aims at being a comprehensive Python API implementation of the +`Pushover Notification Service`_ as documented here__. + +.. _Pushover Notification Service: https://pushover.net/ +.. __: https://pushover.net/api + +Installation +------------ + +You can install python-pushover directly from Pypi_ with ``pip install +python-pushover`` or ``easy_install python-pushover``. + +Or you can install it directly from GitHub_: + +.. code-block:: bash + + git clone https://github.com/Thibauth/python-pushover.git + cd python-pushover + python setup.py install + +.. _Pypi: https://pypi.python.org/pypi/python-pushover/ +.. _GitHub: https://github.com/Thibauth/python-pushover + +Documentation +------------- + +You can access the full documentation here__. + +.. __: http://pythonhosted.org/python-pushover diff --git a/doc/index.rst b/doc/index.rst index 96ae17a..5a0dffe 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,9 +1,26 @@ -Home -==== +Python-pushover documentation +============================= -.. toctree:: +.. include:: ../README.rst + :end-line: -7 + +API documentation +----------------- .. automodule:: pushover :members: :undoc-members: :show-inheritance: + + +Command line +------------- + +The module can also be called from the command line for basic message sending. +The minimum invocation is: + +.. code-block:: bash + + python pushover.py --token <app-token> --client <client-id> "Hello!" + + diff --git a/pushover.py b/pushover.py index 45bfc9a..5f5c61f 100644 --- a/pushover.py +++ b/pushover.py @@ -1,7 +1,4 @@ -""" This modules aims at being a comprehensive implementation of the Pushover -API as described at https://pushover.net/api. - -After being imported, the module must be initialize by calling the :func:`init` +"""After being imported, the module must be initialized by calling the :func:`init` function with a valid application token before sending messages. A typical use of the module looks like this:: |