fork nimvelo3 and start project
This commit is contained in:
16
README.md
16
README.md
@ -1,9 +1,9 @@
|
||||
# Nimvelo Python Client
|
||||
|
||||
Python 2.7 client library for the Nimvelo/Sipcentric API
|
||||
Modern Python client library for the Nimvelo/Sipcentric API
|
||||
|
||||
```python
|
||||
from nimvelo import Nimvelo
|
||||
from nimvelo3 import Nimvelo
|
||||
nimvelo = Nimvelo(username="myusername", password="mypassword")
|
||||
print nimvelo.sms.post(_from="0123", to="03301201200", body="Hello World!")
|
||||
```
|
||||
@ -21,7 +21,7 @@ sudo pip install nimvelo
|
||||
### Manual method
|
||||
|
||||
```
|
||||
git clone git@github.com:Nimvelo/python-client.git && cd python-client
|
||||
git clone git@github.com:faelix/nimvelo3.git && cd nimvelo3
|
||||
sudo python setup.py install
|
||||
```
|
||||
|
||||
@ -32,7 +32,7 @@ sudo python setup.py install
|
||||
**Get account details**
|
||||
|
||||
```python
|
||||
from nimvelo import Nimvelo
|
||||
from nimvelo3 import Nimvelo
|
||||
|
||||
nimvelo = Nimvelo(username="myusername", password="mypassword")
|
||||
|
||||
@ -42,7 +42,7 @@ print nimvelo.account.get()
|
||||
**Connect to the streaming api**
|
||||
|
||||
```python
|
||||
from nimvelo import Nimvelo
|
||||
from nimvelo3 import Nimvelo
|
||||
|
||||
nimvelo = Nimvelo(username="myusername", password="mypassword")
|
||||
stream = nimvelo.Stream
|
||||
@ -61,7 +61,7 @@ stream.connect()
|
||||
|
||||
## Reference
|
||||
|
||||
- nimvelo.Nimvelo(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me')
|
||||
- nimvelo3.Nimvelo(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me')
|
||||
- account
|
||||
- get()
|
||||
- callBundles
|
||||
@ -91,3 +91,7 @@ stream.connect()
|
||||
- register(type, callback)
|
||||
- connect()
|
||||
- disconnect()
|
||||
|
||||
## 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.
|
||||
|
Reference in New Issue
Block a user