jasmin


Namejasmin JSON
Version 0.11.0 PyPI version JSON
download
home_pagehttps://www.jasminsms.com
SummaryJasmin is a very complete open source SMS Gateway with many enterprise-class features.
upload_time2023-11-10 23:21:06
maintainer
docs_urlNone
authorJookies LTD
requires_python
licenseApache v2.0
keywords jasmin sms messaging smpp smsc smsgateway
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/jookies/jasmin/master/misc/doc/sources/_static/jasmin-logo-small.png

Jasmin - Open source SMS gateway
################################

|contribs| |ubuntu-package| |redhat-package| |ci| |docker| |docs| |support|

Introduction
************
Jasmin is a very complete open source SMS Gateway with many enterprise-class features such as:

* SMPP Client / Server
* HTTP Client / Server
* Console-based configuration, no service restart required
* Based on AMQP broker for store&forward mechanisms and other queuing systems
* Using Redis for in-memory DLR tracking and billing
* Advanced message routing/filtering (Simple, Roundrobin, Failover, HLR lookup, Leastcost ...)
* Supports Unicode (UTF-8) for sending out multilingual SMS
* Supports easy creation and sending of specialized/binary SMS like mono Ringtones, WAP Push, Vcards
* Supports concatenated SMS strings (long SMS)

Jasmin relies heavily on message queuing through message brokers (Using AMQP), it is designed for performance,
high traffic loads and full in-memory execution.

.. figure:: https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg
   :alt: Powered by DigitalOcean
   :align: Center
   :figwidth: 210px
   :target: https://www.digitalocean.com/

Architecture
************

.. figure:: https://github.com/jookies/jasmin/raw/master/misc/doc/sources/resources/architecture/hld.png
   :alt: HLD Architecture
   :align: Center
   :figwidth: 100%
   :target: https://docs.jasminsms.com/en/latest/architecture/index.html

Jasmin core and its external connectors (used for AMQP, Redis, SMPP, HTTP, Telnet ...) are written in Python
and are mainly based on `Twisted matrix <https://twistedmatrix.com/>`_, an event-driven networking engine.

Getting started
***************
Refer to `Installation steps <http://docs.jasminsms.com/en/latest/installation/index.html>`_ to get Jasmin gateway up and running quickly with a simple SMS sending scenario.

Documentation
*************
The documentation is at: http://docs.jasminsms.com

If you still need to build it locally::

  $ cd misc/doc
  $ make html
  ...
  ...
  Build finished. The HTML pages are in build/html.

Links
*****

* `Project home page <http://www.jasminsms.com>`_
* `Documentation <http://docs.jasminsms.com>`_
* `Support <https://groups.google.com/forum/#!forum/jasmin-sms-gateway>`_
* `Continuous Integration <https://github.com/jookies/jasmin/actions>`_
* `Source code <https://github.com/jookies/jasmin>`_
* `Kubernetes deployment <https://docs.jasminsms.com/en/latest/installation/index.html#kubernetes-cluster>`_ or `/Experimental/ Deploy to Heroku <https://heroku.com/deploy?template=https://github.com/jookies/jasmin>`_

Contributors
************

.. figure:: https://opencollective.com/jookies/contributors.svg?width=840&button=false
   :alt: Contributors
   :align: Center
   :figwidth: 100%
   :target: https://github.com/jookies/jasmin/graphs/contributors

License
*******
Jasmin is released under the terms of the [Apache License Version 2]. See **`LICENSE`** file for details.

Credits
*******

* Supported by `DigitalOcean <https://www.digitalocean.com/>`_
* Dominic Amato for the extraordinary effort porting Jasmin to Python3: https://github.com/DomAmato
* SMPP PDU parsing based on smpp.pdu: https://github.com/mozes/smpp.pdu
* SMPP 3.4 Client based on smpp.twisted: https://github.com/mozes/smpp.twisted
* GSMP 3.38 based on Python messaging: https://github.com/pmarti/python-messaging

.. |contribs| image:: https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github
    :alt: Contributions welcome
    :scale: 100%
    :target: https://github.com/jookies/jasmin/blob/master/CODE_OF_CONDUCT.md

.. |ci| image:: https://github.com/jookies/jasmin/actions/workflows/ci.yml/badge.svg
    :alt: Build status
    :scale: 100%
    :target: https://github.com/jookies/jasmin/actions

.. |ubuntu-package| image:: https://img.shields.io/badge/package-ubuntu-brightgreen.svg?style=flat-square
    :alt: Ubuntu package
    :scale: 100%
    :target: https://packagecloud.io/jookies/jasmin-sms-gateway

.. |redhat-package| image:: https://img.shields.io/badge/package-redhat-brightgreen.svg?style=flat-square
    :alt: Redhat package
    :scale: 100%
    :target: https://packagecloud.io/jookies/jasmin-sms-gateway

.. |docker| image:: https://github.com/jookies/jasmin/actions/workflows/docker.yml/badge.svg
    :alt: Docker image build status
    :scale: 100%
    :target: https://github.com/jookies/jasmin/actions

.. |docs| image:: https://readthedocs.org/projects/jasmin/badge/?version=latest
    :alt: Documentation status
    :scale: 100%
    :target: http://docs.jasminsms.com

.. |support| image:: https://img.shields.io/badge/discussions-GitHub-333333?logo=github
    :alt: Github discussions
    :scale: 100%
    :target: https://github.com/jookies/jasmin/discussions

            

Raw data

            {
    "_id": null,
    "home_page": "https://www.jasminsms.com",
    "name": "jasmin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "jasmin,sms,messaging,smpp,smsc,smsgateway",
    "author": "Jookies LTD",
    "author_email": "jasmin@jookies.net",
    "download_url": "https://files.pythonhosted.org/packages/d3/2b/364bad8f044fdd19b98b07dd5dbed43c0da4b1d3353fab371324768d1038/jasmin-0.11.0.tar.gz",
    "platform": "POSIX",
    "description": ".. image:: https://raw.githubusercontent.com/jookies/jasmin/master/misc/doc/sources/_static/jasmin-logo-small.png\n\nJasmin - Open source SMS gateway\n################################\n\n|contribs| |ubuntu-package| |redhat-package| |ci| |docker| |docs| |support|\n\nIntroduction\n************\nJasmin is a very complete open source SMS Gateway with many enterprise-class features such as:\n\n* SMPP Client / Server\n* HTTP Client / Server\n* Console-based configuration, no service restart required\n* Based on AMQP broker for store&forward mechanisms and other queuing systems\n* Using Redis for in-memory DLR tracking and billing\n* Advanced message routing/filtering (Simple, Roundrobin, Failover, HLR lookup, Leastcost ...)\n* Supports Unicode (UTF-8) for sending out multilingual SMS\n* Supports easy creation and sending of specialized/binary SMS like mono Ringtones, WAP Push, Vcards\n* Supports concatenated SMS strings (long SMS)\n\nJasmin relies heavily on message queuing through message brokers (Using AMQP), it is designed for performance,\nhigh traffic loads and full in-memory execution.\n\n.. figure:: https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg\n   :alt: Powered by DigitalOcean\n   :align: Center\n   :figwidth: 210px\n   :target: https://www.digitalocean.com/\n\nArchitecture\n************\n\n.. figure:: https://github.com/jookies/jasmin/raw/master/misc/doc/sources/resources/architecture/hld.png\n   :alt: HLD Architecture\n   :align: Center\n   :figwidth: 100%\n   :target: https://docs.jasminsms.com/en/latest/architecture/index.html\n\nJasmin core and its external connectors (used for AMQP, Redis, SMPP, HTTP, Telnet ...) are written in Python\nand are mainly based on `Twisted matrix <https://twistedmatrix.com/>`_, an event-driven networking engine.\n\nGetting started\n***************\nRefer to `Installation steps <http://docs.jasminsms.com/en/latest/installation/index.html>`_ to get Jasmin gateway up and running quickly with a simple SMS sending scenario.\n\nDocumentation\n*************\nThe documentation is at: http://docs.jasminsms.com\n\nIf you still need to build it locally::\n\n  $ cd misc/doc\n  $ make html\n  ...\n  ...\n  Build finished. The HTML pages are in build/html.\n\nLinks\n*****\n\n* `Project home page <http://www.jasminsms.com>`_\n* `Documentation <http://docs.jasminsms.com>`_\n* `Support <https://groups.google.com/forum/#!forum/jasmin-sms-gateway>`_\n* `Continuous Integration <https://github.com/jookies/jasmin/actions>`_\n* `Source code <https://github.com/jookies/jasmin>`_\n* `Kubernetes deployment <https://docs.jasminsms.com/en/latest/installation/index.html#kubernetes-cluster>`_ or `/Experimental/ Deploy to Heroku <https://heroku.com/deploy?template=https://github.com/jookies/jasmin>`_\n\nContributors\n************\n\n.. figure:: https://opencollective.com/jookies/contributors.svg?width=840&button=false\n   :alt: Contributors\n   :align: Center\n   :figwidth: 100%\n   :target: https://github.com/jookies/jasmin/graphs/contributors\n\nLicense\n*******\nJasmin is released under the terms of the [Apache License Version 2]. See **`LICENSE`** file for details.\n\nCredits\n*******\n\n* Supported by `DigitalOcean <https://www.digitalocean.com/>`_\n* Dominic Amato for the extraordinary effort porting Jasmin to Python3: https://github.com/DomAmato\n* SMPP PDU parsing based on smpp.pdu: https://github.com/mozes/smpp.pdu\n* SMPP 3.4 Client based on smpp.twisted: https://github.com/mozes/smpp.twisted\n* GSMP 3.38 based on Python messaging: https://github.com/pmarti/python-messaging\n\n.. |contribs| image:: https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github\n    :alt: Contributions welcome\n    :scale: 100%\n    :target: https://github.com/jookies/jasmin/blob/master/CODE_OF_CONDUCT.md\n\n.. |ci| image:: https://github.com/jookies/jasmin/actions/workflows/ci.yml/badge.svg\n    :alt: Build status\n    :scale: 100%\n    :target: https://github.com/jookies/jasmin/actions\n\n.. |ubuntu-package| image:: https://img.shields.io/badge/package-ubuntu-brightgreen.svg?style=flat-square\n    :alt: Ubuntu package\n    :scale: 100%\n    :target: https://packagecloud.io/jookies/jasmin-sms-gateway\n\n.. |redhat-package| image:: https://img.shields.io/badge/package-redhat-brightgreen.svg?style=flat-square\n    :alt: Redhat package\n    :scale: 100%\n    :target: https://packagecloud.io/jookies/jasmin-sms-gateway\n\n.. |docker| image:: https://github.com/jookies/jasmin/actions/workflows/docker.yml/badge.svg\n    :alt: Docker image build status\n    :scale: 100%\n    :target: https://github.com/jookies/jasmin/actions\n\n.. |docs| image:: https://readthedocs.org/projects/jasmin/badge/?version=latest\n    :alt: Documentation status\n    :scale: 100%\n    :target: http://docs.jasminsms.com\n\n.. |support| image:: https://img.shields.io/badge/discussions-GitHub-333333?logo=github\n    :alt: Github discussions\n    :scale: 100%\n    :target: https://github.com/jookies/jasmin/discussions\n",
    "bugtrack_url": null,
    "license": "Apache v2.0",
    "summary": "Jasmin is a very complete open source SMS Gateway with many enterprise-class features.",
    "version": "0.11.0",
    "project_urls": {
        "Homepage": "https://www.jasminsms.com"
    },
    "split_keywords": [
        "jasmin",
        "sms",
        "messaging",
        "smpp",
        "smsc",
        "smsgateway"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d32b364bad8f044fdd19b98b07dd5dbed43c0da4b1d3353fab371324768d1038",
                "md5": "3136d96c31a342f96a8fb4afb54a2850",
                "sha256": "f5705c8651cc29d8ea8f3e8e97628384145326f55b8ebed146baa46b525c7550"
            },
            "downloads": -1,
            "filename": "jasmin-0.11.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3136d96c31a342f96a8fb4afb54a2850",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1423569,
            "upload_time": "2023-11-10T23:21:06",
            "upload_time_iso_8601": "2023-11-10T23:21:06.949283Z",
            "url": "https://files.pythonhosted.org/packages/d3/2b/364bad8f044fdd19b98b07dd5dbed43c0da4b1d3353fab371324768d1038/jasmin-0.11.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-10 23:21:06",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "jasmin"
}
        
Elapsed time: 0.27316s