Skip to content

Commit

Permalink
Improving documentation in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fhightower committed Oct 8, 2017
1 parent 29d0ebe commit b94b911
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,70 @@ Simple python wrapper for the `Robtex API <https://www.robtex.com/api/>`_ . This
* Free software: MIT license
* Documentation: https://robtex-python.readthedocs.io

Installation
============

Stable release
--------------

To install Robtex Python, run this command in your terminal:

.. code-block:: console
pip install robtex-python
This is the preferred method to install the Robtex API wrapper, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

From sources
------------

The sources for Robtex Python can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console
$ git clone git://github.com/fhightower/robtex-python
Or download the `tarball`_:

.. code-block:: console
$ curl -OL https://github.com/fhightower/robtex-python/tarball/master
Once you have a copy of the source, you can install it with:

.. code-block:: console
$ python3 setup.py install
.. _Github repo: https://github.com/fhightower/robtex-python
.. _tarball: https://github.com/fhightower/robtex-python/tarball/master

Usage
=====

Via Python
----------

You can use Robtex Python in a script as follows:

.. code-block:: python
from robtex_python import robtex_python
response = robtex_python.pdns_forward("example.com")
Via Command Line
----------------

Support for Robtex Python from the command line is coming soon!

Credits
=======

Expand Down

0 comments on commit b94b911

Please sign in to comment.