Skip to main content

Naz is an SMPP client.

Project description

naz

Codacy Badge CircleCI codecov

naz is an SMPP client.
It’s name is derived from Kenyan hip hop artiste, Nazizi.

SMPP is a protocol designed for the transfer of short message data between External Short Messaging Entities(ESMEs), Routing Entities(REs) and Short Message Service Center(SMSC). - https://en.wikipedia.org/wiki/Short_Message_Peer-to-Peer

naz currently only supports the SMPP version 3.4.

naz is in active development and it’s API may change in backward incompatible ways.

Installation

pip install naz

Usage

import naz

CLI

naz also ships with a commandline interface(called naz.
run:
naz ....

To see help:

naz --help

## Features

Development setup

  • fork this repo.

  • you need to have python3 installed, this project is python3 only.

  • cd naz

  • sudo apt-get install pandoc

  • open an issue on this repo. In your issue, outline what it is you want to add and why.

  • install pre-requiste software:

apt-get -y install pandoc && pip install -e .[dev,test]
  • make the changes you want on your fork.

  • your changes should have backward compatibility in mind unless it is impossible to do so.

  • add your name and contact(optional) to CONTRIBUTORS.md

  • add tests

  • format your code using autopep8:

autopep8 --experimental --in-place -r -aaaaaaaaaaa .
  • run flake8 on the code and fix any issues:

flake8 .
  • run pylint on the code and fix any issues:

pylint --enable=E --disable=W,R,C naz/
  • run tests and make sure everything is passing:

make test
  • open a pull request on this repo. NB: I make no commitment of accepting your pull requests.

## TODO

Project details


Download files

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

Source Distribution

naz-0.0.0.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

naz-0.0.0.1-py3-none-any.whl (2.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page