8000 Update RC docs · dozure/twilio-python@b1b20c2 · GitHub
[go: up one dir, main page]
Skip to content

Commit b1b20c2

Browse files
author
Carlos Diaz-Padron
committed
Update RC docs
1 parent 715d3a2 commit b1b20c2

8000

File tree

2 files changed

+36
-21
lines changed

2 files changed

+36
-21
lines changed

‎README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Python library documentation")
1313
Install from PyPi using [pip](http://www.pip-installer.org/en/latest/), a
1414
package manager for Python.
1515

16-
pip install twilio
16+
pip install twilio~=6.0.0-rc1
1717

1818
Don't have pip installed? Try installing it, by running this from the command
1919
line:
@@ -28,25 +28,31 @@ source code") for `twilio-python`, and then run:
2828

2929
You may need to run the above commands with `sudo`.
3030

31+
### Migrate from 5.x
32+
[Upgrade Guide][upgrade]
33+
34+
## Documentation
35+
[Here][documentation]
36+
3137
## Getting Started
3238

3339
Getting started with the Twilio API couldn't be easier. Create a
34-
`TwilioRestClient` and you're ready to go.
40+
`Client` and you're ready to go.
3541

3642
### API Credentials
3743

38-
The `TwilioRestClient` needs your Twilio credentials. You can either pass these
44+
The `Twilio` needs your Twilio credentials. You can either pass these
3945
directly to the constructor (see the code below) or via environment variables.
4046

4147
```python
42-
from twilio.rest import TwilioRestClient
48+
from twilio.rest import Client
4349

4450
account = "ACXXXXXXXXXXXXXXXXX"
4551
token = "YYYYYYYYYYYYYYYYYY"
46-
client = TwilioRestClient(account, token)
52+
client = Client(account, token)
4753
```
4854

49-
Alternately, a `TwilioRestClient` constructor without these parameters will
55+
Alternately, a `Client` constructor without these parameters will
5056
look for `TWILIO_ACCOUNT_SID` and `TWILIO_AUTH_TOKEN` variables inside the
5157
current environment.
5258

@@ -56,18 +62,18 @@ somewhere public.
5662

5763

5864
```python
59-
from twilio.rest import TwilioRestClient
60-
client = TwilioRestClient()
65+
from twilio.rest import Client
66+
client = Client()
6167
```
6268

6369
### Make a Call
6470

6571
```python
66-
from twilio.rest import TwilioRestClient
72+
from twilio.rest import Client
6773

6874
account = "ACXXXXXXXXXXXXXXXXX"
6975
token = "YYYYYYYYYYYYYYYYYY"
70-
client = TwilioRestClient(account, token)
76+
client = Client(account, token)
7177

7278
call = client.calls.create(to="9991231234",
7379
from_="9991231234",
@@ -78,11 +84,11 @@ print(call.sid)
7884
### Send an SMS
7985

8086
```python
81 8000 -
from twilio.rest import TwilioRestClient
87+
from twilio.rest import Client
8288

8389
account = "ACXXXXXXXXXXXXXXXXX"
8490
token = "YYYYYYYYYYYYYYYYYY"
85-
client = TwilioRestClient(account, token)
91+
client = Client(account, token)
8692

8793
message = client.messages.create(to="+12316851234", from_="+15555555555",
8894
body="Hello there!")
@@ -132,3 +138,6 @@ use.
132138
[recordings]: http://twilio-python.readthedocs.org/en/latest/usage/recordings.html#listing-your-recordings
133139
[messages]: http://twilio-python.readthedocs.org/en/latest/usage/messages.html#retrieving-sent-messages
134140
[calls]: http://twilio-python.readthedocs.org/en/latest/usage/phone-calls.html#retrieve-a-call-record
141+
[issues]: https://github.com/twilio/twilio-python/issues
142+
[documentation]: http://twilio-python.readthedocs.org
143+
[upgrade]: https://github.com/twilio/twilio-python/wiki/Python-Version-6.x-Upgrade-Guide

‎docs/index.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ package manager for Python.
1212

1313
.. code-block:: bash
1414
15-
pip install twilio=6.0.0rc1
15+
pip install twilio~=6.0.0rc1
1616
1717
Don't have pip installed? Try installing it, by running this from the command
1818
line:
@@ -32,6 +32,20 @@ library, and then running:
3232
python setup.py install
3333
3434
35+
Migrate from 5.x
36+
==================
37+
38+
`twilio-python` 6.0 introduced backwards-incompatible changes to the API. See
39+
the `upgrade-guide <https://github.com/twilio/twilio-python/wiki/Python-Version-6.x-Upgrade-Guide>`_ for step-by-step instructions for migrating to 6.0.
40+
In many cases, the same methods are still offered, just in different locations.
41+
42+
43+
Feedback
44+
================
45+
46+
Report any feedback or problems with this Release Candidate to the `Github Issues <https://github.com/twilio/twilio-python/issues>`_ for twilio-python.
47+
48+
3549
Getting Started
3650
================
3751

@@ -98,14 +112,6 @@ Small functions useful for validating requests are coming from Twilio
98112
usage/token-generation
99113

100114

101-
Upgrade Plan
102-
==================
103-
104-
`twilio-python` 6.0 introduced backwards-incompatible changes to the API. See
105-
the :doc:`/upgrade-guide` for step-by-step instructions for migrating to 6.0.
106-
In many cases, the same methods are still offered, just in different locations.
107-
108-
109115
API Reference
110116
==================
111117

0 commit comments

Comments
 (0)
0