This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
python-statuspageio
==============

StatusPage.oi API V1 library client for Python. Based on the documentaion from https://doers.statuspage.io/api/v1/

Provides most of the funcitonality for the http://statuspage.io api's via handy python code.


Installation
------------

Statuspageio package can be installed either via pip:

.. code:: bash

$ pip install --upgrade statuspageio



You can install from the source code as well. First clone the repo and
then execute:

.. code:: bash

$ python setup.py install

After installing, import ``statuspageio`` package:

.. code:: python

import statuspageio

Usage
-----

.. code:: python

import statuspageio

# Then we instantiate a client (as shown below)

Build a client
~~~~~~~~~~~~~~

**Using this api without authentication gives an error**

.. code:: python

client = statuspageio.Client(api_key='<your_personal_api_key>', page_id=<your_personal_page_id')<br>or
client = statuspageio.Client(api_key='<your_personal_api_key>', page_id=<your_personal_page_id',organization_id=<your_personal_organization_id)<br>

Client Options
~~~~~~~~~~~~~~

The following options are available while instantiating a client:

- **api\_key**: Personal API Key
- **page\_id**: Personal page id
- **organization\_id**: Personal organization id, used for managing users.
- **base\_url**: Base url for the api
- **user\_agent**: Default user-agent for all requests
- **timeout**: Request timeout
- **verbose**: Verbose/debug mode

Architecture
~~~~~~~~~~~~

The library follows few architectural principles you should understand
before digging deeper. 1. Interactions with resources are done via
service objects. 2. Service objects are exposed as properties on client
instances. 3. Service objects expose resource-oriented actions. 4.
Actions return dictionaries that support attribute-style access, a la
JavaScript (thanks to Bunch and it's form Munch).

For example, to interact with components API you will use
``statuspageio.ComponentsService``, which you can get if you call:

.. code:: python

client = statuspageio.Client(api_key='<your_personal_api_key>', page_id=<your_personal_page_id')<br> client.components # statuspageio.ComponentsService

To retrieve list of resources and use filtering you will call ``#list``
method:

.. code:: python

client = statuspageio.Client(api_key='<your_personal_api_key>', page_id=<your_personal_page_id')<br> client.components.list() # list(dict|Munch)



Resources and actions
---------------------

Documentation for every action can be found in ``statuspageio/services.py``
file.


Tests
-----

Sorry. These need to be written.


Thanks
------

Thank you to the BaseCRM development team who created the majority of the code for this project.
We forked the code as the aritectural style worked really well for this project.
Please see https://github.com/basecrm/basecrm-python for more details

Thank you so much!

License
-------

MIT

Bug Reports
-----------

Report `here <https: github.com="" gamesparks="" python-statuspageio="" issues="">`__.
Release History

Release History

0.0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
statuspageio-0.0.1.tar.gz (11.0 kB) Copy SHA256 Checksum SHA256 Source Feb 1, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting