diff --git a/README.md b/README.md index f0a16f0..07810bd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# Nimvelo Python Client +# Simwood Partner Python Client -Modern Python client library for the Nimvelo/Sipcentric API +A modern Python client library for Sipcentric +([Simwood Partner](https://simwood.com/uk/partner/), formerly Nimvelo) +[API](https://developer.simwood.com/docs/direct/introduction/). ```python -from nimvelo3 import Nimvelo -nimvelo = Nimvelo(username="myusername", password="mypassword") -print nimvelo.sms.post(_from="0123", to="03301201200", body="Hello World!") +from sipcentric import Sipcentric +api = Sipcentric(username="myusername", password="mypassword") +print api.sms.post(_from="0123", to="03301201200", body="Hello World!") ``` ## Install @@ -13,15 +15,15 @@ print nimvelo.sms.post(_from="0123", to="03301201200", body="Hello World!") ### Best method ``` -sudo pip install nimvelo +sudo pip install sipcentric ``` -*You may need to install `simplejson` and `multiprocessing` if you don't have them already.* +*You may need to install `simplejson` if you don't have it already.* ### Manual method ``` -git clone git@github.com:faelix/nimvelo3.git && cd nimvelo3 +git clone git@github.com:faelix/sipcentric.git && cd sipcentric sudo python setup.py install ``` @@ -32,20 +34,20 @@ sudo python setup.py install **Get account details** ```python -from nimvelo3 import Nimvelo +from sipcentric import Sipcentric -nimvelo = Nimvelo(username="myusername", password="mypassword") +api = Sipcentric(username="myusername", password="mypassword") -print nimvelo.account.get() +print api.account.get() ``` **Connect to the streaming api** ```python -from nimvelo3 import Nimvelo +from sipcentric import Sipcentric -nimvelo = Nimvelo(username="myusername", password="mypassword") -stream = nimvelo.Stream +api = Sipcentric(username="myusername", password="mypassword") +stream = api.Stream def callHandler(call): print 'Incoming call from ' + call['callerIdName'] + ' (' + call['callerIdNumber'] + ')' @@ -61,7 +63,7 @@ stream.connect() ## Reference -- nimvelo3.Nimvelo(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me') +- sipcentric.Sipcentric(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me') - account - get() - callBundles @@ -94,4 +96,6 @@ stream.connect() ## History -This project was forked from Nimvelo's original project (for Python 2.7) [python-client](https://github.com/Nimvelo/python-client). The name was changed to `nimvelo3` to make migration to Python 3.x codebases as simple as possible. +This project was forked from Nimvelo's original project (for Python 2.7) +[python-client](https://github.com/Nimvelo/python-client). The name was +changed to `sipcentric` after discussion with the development team at Simwood. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..374b58c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=42", + "wheel" +] +build-backend = "setuptools.build_meta" diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..a53f4ed --- /dev/null +++ b/setup.cfg @@ -0,0 +1,34 @@ +[metadata] +name = sipcentric +version = 0.0.0 +author = Marek Isalski +author_email = pypi-sipcentric@maz.nu +description = Modern Python client library for the Sipsentric (Simwood Partner, formerly Nimvelo) API +long_description = file: README.md +long_description_content_type = text/markdown +url = https://github.com/faelix/sipcentric +project_urls = + Bug Tracker = https://github.com/faelix/sipcentric/issues +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: MIT License + Operating System :: OS Independent +keywords = sipcentric, simwood, nimvelo, voip, pbx, sms, sip + +[options] +package_dir = + = src +packages = find: +python_requires = >=3.6 +install_requires = + requests + simplejson +requires = + math + json + logging + time + simplejson + +[options.packages.find] +where = src diff --git a/setup.py b/setup.py deleted file mode 100755 index 28f913b..0000000 --- a/setup.py +++ /dev/null @@ -1,24 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# setup.py -# Modern Python client library for the Simwood Partner (Nimvelo/Sipcentric) API -# Copyright (c) 2015 Sipcentric Ltd. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php -# Copyright (c) 2022 Faelix Limited. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php - -import os -from setuptools import setup - -setup( - name='nimvelo3', - description='Modern Python client library for the Simwood Partner (Nimvelo/Sipcentric) API', - version='0.1.4', - url='https://github.com/faelix/nimvelo3', - author='Marek Isalski', - author_email='pypi-nimvelo3@maz.nu', - license='MIT', - keywords='nimvelo sipcentric simwood voip pbx sms sip', - packages=['nimvelo3', 'nimvelo3/stream'], - requires=['math', 'json', 'logging', 'time', 'simplejson'], - install_requires=['requests', 'simplejson'], -) diff --git a/nimvelo3/__init__.py b/src/sipcentric/__init__.py similarity index 97% rename from nimvelo3/__init__.py rename to src/sipcentric/__init__.py index 06ddfbd..481d553 100644 --- a/nimvelo3/__init__.py +++ b/src/sipcentric/__init__.py @@ -1,8 +1,8 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -# nimvelo/__init__.py -# Modern Python client library for the Simwood Partner (Nimvelo/Sipcentric) API +# sipcentric/__init__.py +# Modern Python client library for the Sipcentric (Simwood Partner, formerly Nimvelo) API # Copyright (c) 2015 Sipcentric Ltd. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php # Copyright (c) 2022 Faelix Limited. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php @@ -19,7 +19,7 @@ from .stream import Stream logger = logging.getLogger(__name__) -class Nimvelo(object): +class Sipcentric(object): def __init__(self, username, password, base='https://pbx.sipcentric.com/api/v1', customer='me'): diff --git a/nimvelo3/stream/__init__.py b/src/sipcentric/stream/__init__.py similarity index 95% rename from nimvelo3/stream/__init__.py rename to src/sipcentric/stream/__init__.py index e9ef989..8b2e1ed 100644 --- a/nimvelo3/stream/__init__.py +++ b/src/sipcentric/stream/__init__.py @@ -1,8 +1,8 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -# nimvelo/stream/__init__.py -# Modern Python client library for the Simwood Partner (Nimvelo/Sipcentric) API +# sipcentric/stream/__init__.py +# Modern Python client library for the Sipcentric (Simwood Partner, formerly Nimvelo) API # Copyright (c) 2015 Sipcentric Ltd. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php # Copyright (c) 2022 Faelix Limited. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php