Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Python library for Octopush API

Project Description

A Python library for Octopush API.

Octopush offers a solution that was built in-house as a hosted service (SaaS, Software as a Service and an API) to allow marketing departments of major groups, advertising agencies and IT companies to enjoy an infrastructure that supports sending SMS messages to more than 200 countries.


Install via PyPI

pip install octopush

Or add octopush to your application’s requirements file and then run

pip install -r requirements.txt

Or from source code

git clone
cd octopush-api-python
python install


Config file (config.js)

import octopush
import datetime

config = {
    'user_login': '*******@*******',
    'api_key': '****************',
    'sms_recipients': ['+33600000000'],
    'sms_text': 'test text ' +"%Y-%m-%d %H:%M"),
    'sms_type': octopush.SMS_WORLD,
    'sms_sender': 'onesender'

Balance check

from octopush import SMS
from config import config

sms = SMS(config['user_login'], config['api_key'])

result = sms.get_balance()

for balance in result.findall('balance'):
    print(balance.attrib['type'], balance.text)

SMS sending

from octopush import SMS
from config import config
import uuid

sms = SMS(config['user_login'], config['api_key'])

result = sms.send()


More examples can be found in Simple Examples and Advanced Examples.



This library is completely documented using PyDoc and will show autocompletions in all editors that supports it. Alternatively you can build HTML version of documentation via pydoc tool.

API documentation available on Octopush API documentation portal.

Release History

Release History

This version
History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date (13.2 kB) Copy SHA256 Checksum SHA256 Source Feb 5, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS 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