Documentation

README.rst

@@ -2,6 +2,26 @@ Azure Kit
 =========
 
 
+|Docs| |Version| |Pypi| |Codacy| |Coverage|
+
+
+.. |Docs| image:: https://readthedocs.org/projects/azurekit/badge/?version=latest
+   :target: http://azurekit.readthedocs.io/en/latest/?badge=latest
+   :alt: Read the Docs
+.. |Version| image:: https://img.shields.io/pypi/pyversions/azurekit.svg
+   :target: https://pypi.org/project/azurekit/
+   :alt: PyPI - Python Version
+.. |Pypi| image:: http://img.shields.io/pypi/v/azurekit.svg?style=flat
+    :target: https://pypi.python.org/pypi/azurekit/
+    :alt: Package Version
+.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/771dc538da464b5ea35df936bc4fe29e
+    :target: https://www.codacy.com/app/davidmoremad/azurekit?utm_source=github.com&utm_medium=referral&utm_content=davidmoremad/azurekit&utm_campaign=Badge_Grade
+    :alt: Codacy
+.. |Coverage| image:: https://api.codacy.com/project/badge/Coverage/771dc538da464b5ea35df936bc4fe29e
+    :target: https://www.codacy.com/app/davidmoremad/azurekit?utm_source=github.com&utm_medium=referral&utm_content=davidmoremad/azurekit&utm_campaign=Badge_Coverage
+    :alt: Coverage
+
+
 *****************
 What is AzureKit?
 *****************

docs/source/index.rst

@@ -11,6 +11,43 @@ Welcome to azurekit's documentation!
    :caption: Contents:
 
 
+|Docs| |Version| |Pypi| |Codacy| |Coverage|
+
+
+.. |Docs| image:: https://readthedocs.org/projects/azurekit/badge/?version=latest
+   :target: http://azurekit.readthedocs.io/en/latest/?badge=latest
+   :alt: Read the Docs
+.. |Version| image:: https://img.shields.io/pypi/pyversions/azurekit.svg
+   :target: https://pypi.org/project/azurekit/
+   :alt: PyPI - Python Version
+.. |Pypi| image:: http://img.shields.io/pypi/v/azurekit.svg?style=flat
+    :target: https://pypi.python.org/pypi/azurekit/
+    :alt: Package Version
+.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/771dc538da464b5ea35df936bc4fe29e
+    :target: https://www.codacy.com/app/davidmoremad/azurekit?utm_source=github.com&utm_medium=referral&utm_content=davidmoremad/azurekit&utm_campaign=Badge_Grade
+    :alt: Codacy
+.. |Coverage| image:: https://api.codacy.com/project/badge/Coverage/771dc538da464b5ea35df936bc4fe29e
+    :target: https://www.codacy.com/app/davidmoremad/azurekit?utm_source=github.com&utm_medium=referral&utm_content=davidmoremad/azurekit&utm_campaign=Badge_Coverage
+    :alt: Coverage
+
+
+*****************
+What is AzureKit?
+*****************
+
+Azurekit is a Python SDK for managing your Azure accounts and all deployed resources.
+You will be able to list all the inventory of the organization,
+make queries at the management level and above all, automate and speed up your day to day.
+
+The objective of the SDK is to abstract the use of Azure, being able to dig through all the data of our account,
+and for example you will be able of:
+
+* Run a SSH-Command on all the machines on your different accounts.
+* List all instances with exposed critical ports like 22 or 3389
+* Get info about all certificates of your account/s
+* Obtain all the infrastructure after a domain associated with a balancer
+* Get the price per account or resource_group in a few seconds.
+
 
 Indices and tables
 ==================

requirements-dev.txt

@@ -10,3 +10,5 @@ codacy-coverage==1.3.11
 
 # Documentation
 Sphinx==1.5.1
+sphinx_rtd_theme
+sphinxcontrib.napoleon

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27, py33, py34, py35, py36
+envlist = py27, py34, py35, py36
 
 [testenv]
 passenv = TRAVIS TRAVIS_JOB_ID TRAVIS_BRANCH AZURE_AUTH_LOCATION CODACY_PROJECT_TOKEN