Metadata-Version: 2.0
Name: pystackalytics
Version: 0.1.3
Summary: Python wrapper for Mirantis Stackalytics API.
Home-page: https://github.com/vu3jej/pystackalytics
Author: Jithesh E J
Author-email: mail@jithesh.net
License: MIT
Keywords: pystackalytics
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests

===============================
pystackalytics
===============================

.. image:: https://img.shields.io/travis/vu3jej/pystackalytics.svg
        :target: https://travis-ci.org/vu3jej/pystackalytics

.. image:: https://img.shields.io/pypi/v/pystackalytics.svg
        :target: https://pypi.python.org/pypi/pystackalytics


Python wrapper for Mirantis Stackalytics API.

* Free software: The MIT License
* Documentation: https://pystackalytics.readthedocs.org.

Usage
-----

.. code:: python

        from pystackalytics import Stackalytics
        api = Stackalytics()
        api.companies(release='kilo').stats[1].name
        # u'Mirantis'

All methods support common set of parameters that allow to filter resulting data.

.. csv-table::
    :header: "Parameter", "Description"
    :widths: 20, 50

    "release", "Name of OpenStack release or ‘all’, by default current release"
    "project_type", "Type of project, by default ‘openstack’"
    "module", "Name of module (repository name)"
    "company", "Company name"
    "user_id", "Launchpad id of user or email if no Launchpad id is mapped."
    "metric", "Metric: e.g. ‘commits’, ‘loc’, ‘marks’, ‘emails’"
    "start_date", "When the period starts"
    "end_date", "When the period ends"

Features
--------

* TODO




History
-------

0.1.0 (2015-10-14)
---------------------

* First release on PyPI.


