Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nijel/odorik

Python module to work with Odorik API
https://github.com/nijel/odorik

Last synced: about 1 month ago
JSON representation

Python module to work with Odorik API

Awesome Lists containing this project

README

        

Python module for Odorik API
============================

.. image:: https://travis-ci.org/nijel/odorik.svg?branch=master
:target: https://travis-ci.org/nijel/odorik
:alt: Build Status

.. image:: https://ci.appveyor.com/api/projects/status/opljwukflxucyrfx/branch/master?svg=true
:alt: Build status
:target: https://ci.appveyor.com/project/nijel/odorik/branch/master

.. image:: https://landscape.io/github/nijel/odorik/master/landscape.svg?style=flat
:target: https://landscape.io/github/nijel/odorik/master
:alt: Code Health

.. image:: https://api.codacy.com/project/badge/Grade/14a6d6258e234787b8cd05cf5a8035ca
:target: https://www.codacy.com/app/nijel/odorik

.. image:: http://codecov.io/github/nijel/odorik/coverage.svg?branch=master
:target: http://codecov.io/github/nijel/odorik?branch=master
:alt: Code coverage

.. image:: https://img.shields.io/pypi/dm/odorik.svg
:target: https://pypi.python.org/pypi/odorik
:alt: PyPI package

.. image:: https://hosted.weblate.org/widgets/odorik/-/svg-badge.svg
:alt: Translation status
:target: https://hosted.weblate.org/engage/odorik/?utm_source=widget

Documentation
-------------

See http://odorik.readthedocs.io/en/latest/ for module documentation.

See http://www.odorik.cz/w/api for API documentation.

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

Use pip to install::

pip install odorik

Command line utility
--------------------

The module comes with handy command line utility::

$ odorik balance
balance: 123.45

$ odorik mobile-data --phone 00420789123456
bytes_total: 111593707
bytes_down: 87039672
bytes_up: 24554035
price: 0

$ odorik send-sms 00420789123456 "Ahoj, jak se mas?"

$ odorik summary
Pepa
id: 716000
public_number: 00420789789789
call_count: 58
sms_count: 42
bytes_total: 145921813
data_price: 0.01
call_price: 24.28
sms_price: 12.31
price: 36.59

Franta
id: 717000
public_number: 00420789123456
call_count: 11
sms_count: 0
bytes_total: 0
data_price: 0
call_price: 2.20
sms_price: 0
price: 2.20

See http://odorik.readthedocs.io/en/latest/command.html for more information.