webobsclient 0.1.0

WebObs Python Client

webobsclient

WebObs Python client.

Installation

webobsclient is available on PyPI, you can install it by typing this command:

pip install -U webobsclient

Requirements

• Python 3.5+
• httplib2
• six
• pandas (for parsing CSV and other data processing)
• sqlalchemy

Making Requests

You need to specify username and password credentials of your WebObs access login in order to make a request. For example:

import webobsclient

client = webobsclient.MC3Client(username='USER', password='PASSWORD')
response, content = client.request(
    slt=0, y1=2019, m1=6, d1=15, h1=0, y2=2019, m2=7, d2=15, h2=4, type='ALL',
    duree='ALL', ampoper='eq', amplitude='ALL', locstatus=0, located=0,
    hideloc=0, mc='MC3', dump='bul', graph='movsum')

print(response)
print(content)

Sometimes, using y1, m1, d1, and h1 options are inconvenient. You can use starttime, and endtime options indicating time range of your request. For example:

import webobsclient

client = webobsclient.MC3Client(username='USER', password='PASSWORD')
response, content = client.request(
    starttime='2019-06-15', endtime='2019-07-15', slt=0, type='ALL',
    duree='ALL', ampoper='eq', amplitude='ALL', locstatus=0, located=0,
    hideloc=0, mc='MC3', dump='bul', graph='movsum')

print(response)
print(content)

Note that starttime and endtime options are only available on MC3Client.

Another example for Sefran3 client:

import webobsclient

client = webobsclient.Sefran3Client(username='USER', password='PASSWORD')
response, content = client.request(
    s3='SEFRAN', mc3='MC3', date='201907150829', id=550)

print(response)
print(content)

Note that date time in the request and WebObs are both in UTC time zone. If you use local time zone, you should convert it to UTC time zone before making the request.

Parsing MC3 CSV Bulletin

webobsclient provides some utility classes to enable MC3 CSV parsing from WebObs response:

from webobsclient import MC3Client
from webobsclient.parser import MC3Parser

client = MC3Client(username='USER', password='PASSWORD')

response, content = client.request(
    type='VTA', starttime='2019-10-01', endtime='2019-10-31', slt=0,
    duree='ALL', ampoper='eq', amplitude='ALL', locstatus=0, located=0,
    hideloc=0, mc='MC3', dump='bul', graph='movsum')

parser = MC3Parser(content, use_local_tz=True)
print(parser.to_dictionary())

The above example request VTA earthquake event to the WebObs MC3 bulletin from 2019-10-01 to 2019-10-31. We create a parser instance with use_local_tz=True option. This will convert any date time types from UTC (WebObs use UTC time zone) to Asia/Jakarta time zone because MC3Parser class uses Asia/Jakarta time zone by default. Method to_dictionary() will convert MC3 CSV to Python dictionary.

MC3 CSV is parsed using pre-defined column shemas. You can see the column schemas in webobsclient/schemas.py.

For more information about available methods, see the source in webobsclient/parser.py.

Supported WebObs Clients

Currently only WebObs MC3 and Sefran3 is supported. More client will be added in the future version.

Support

This project is maintained by Indra Rudianto. If you have any question about this project, you can contact him at [e-mail].

License

By contributing to the project, you agree that your contributions will be licensed under its MIT license. See LICENSE for details.