Metadata-Version: 2.1
Name: exosip2ctypes
Version: 1.2.2
Summary: libeXosip2 Python wrapper
Home-page: http://github.com/tanbro/exosip2ctypes
Author: Liu Xue Yan
Author-email: realtanbro@gmail.com
License: GPL
Keywords: sip osip osip2 libosip lilbosip2 eXosip eXosip2 libeXosip2 exosip2ctypes
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications :: Telephony
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Requires-Dist: futures; python_version < "3.0"
Requires-Dist: enum34; python_version < "3.4"

:Source: http://github.com/tanbro/exosip2ctypes/
:Document: http://exosip2ctypes.readthedocs.org/
:Repo: http://pypi.org/project/exosip2ctypes/

|travis| |codacy-grade| |codacy-coverage| |readthedocs| |pylicense| |pyversion| |pyimp| |pyformat| |pystatus|

------

eXosip2CTypes
==============

eXosip2CTypes is a `python`_ package, it wraps `eXosip2`_.

It is based on `ctypes`_, and loads `eXosip2`_ shared object on runtime.

Environment
-----------

OS:

* Linux
* MacOS

`Python`_ Version:

* Python2.x: 2.7
* Python3.x: 3.3 and later

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

1. Install `eXosip2`_.

    The library `eXosip2`_ depends on `osip2`_, they are native ``C`` libraries.
    You can compile these two libraries from source code, or install them by package managers if possible.
    For example, ubuntu 16.04 users can install the libraries::

        sudo apt install libexosip2-11

    "develop" packages are not needed.

2. Install `python`_

    Install `python`_ 2.7 or `python`_ 3.3+.
    Avoid this if it's already in your OS.

3. Install eXosip2CTypes

    It's advised to install eXosip2CTypes using `pip`_::

        pip install exosip2ctypes

    Or clone from http://github.com/tanbro/exosip2ctypes, then execute ``setup.py``::

        https://github.com/tanbro/exosip2ctypes.git
        cd exosip2ctypes
        path/of/your/python setup.py install

Development
-----------

Now, your can use it in your APP, Good luck!

Visit http://exosip2ctypes.readthedocs.org/ for the api docs.

The project's API documentation is written inside the source code as `Docstring`_ ,
you shall build the documentation from source, using `sphinx-doc`_ .

Check blow documentations for more infomations:

* http://www.antisip.com/doc/exosip2/index.html
* http://www.gnu.org/software/osip/doc/html/index.html

.. _osip2: http://www.gnu.org/software/osip/

.. _eXosip2: http://www.gnu.org/software/osip/

.. _python: http://python.org/

.. _pip: http://pypi.python.org/pypi/pip

.. _ctypes: http://docs.python.org/3/library/ctypes.html

.. _enum34: http://pypi.python.org/pypi/enum34

.. _futures: http://pypi.python.org/pypi/futures

.. _Docstring: http://www.python.org/dev/peps/pep-0257/

.. _sphinx-doc: http://sphinx-doc.org/

.. _virtualenv: https://pypi.python.org/pypi/virtualenv

.. |travis| image:: https://img.shields.io/travis/tanbro/exosip2ctypes.svg
   :target: https://travis-ci.org/tanbro/exosip2ctypes

.. |codacy-grade| image:: https://img.shields.io/codacy/grade/842a184f326741ca8ed208bd33238b6c.svg
    :target: https://www.codacy.com/app/tanbro/exosip2ctypes?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tanbro/exosip2ctypes&amp;utm_campaign=Badge_Grade

.. |codacy-coverage| image:: https://img.shields.io/codacy/coverage/842a184f326741ca8ed208bd33238b6c.svg
    :target: https://www.codacy.com/app/tanbro/exosip2ctypes?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tanbro/exosip2ctypes&amp;utm_campaign=Badge_Grade

.. |readthedocs| image:: https://readthedocs.org/projects/exosip2ctypes/badge/?version=latest
    :target: http://exosip2ctypes.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |pylicense| image:: https://img.shields.io/pypi/l/exosip2ctypes.svg
    :alt: GNU GENERAL PUBLIC LICENSE
    :target: http://www.antisip.com/doc/exosip2/eXosip2_license.html

.. |pyversion| image:: https://img.shields.io/pypi/pyversions/exosip2ctypes.svg
    :alt: Supported Python versions.
    :target: http://pypi.python.org/pypi/exosip2ctypes/

.. |pyimp| image:: https://img.shields.io/pypi/implementation/exosip2ctypes.svg
    :alt: Support Python implementations.
    :target: http://pypi.python.org/pypi/exosip2ctypes/

.. |pyformat| image:: https://img.shields.io/pypi/format/exosip2ctypes.svg
    :target: http://pypi.python.org/pypi/exosip2ctypes/

.. |pystatus| image:: https://img.shields.io/pypi/status/exosip2ctypes.svg
    :target: http://pypi.python.org/pypi/exosip2ctypes/


