-
Notifications
You must be signed in to change notification settings - Fork 766
Migrate the README to markdown #463
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# twilio-python | ||
|
||
[](http://travis-ci.org/twilio/twilio-python) | ||
[](https://pypi.python.org/pypi/twilio) | ||
[](https://pypi.python.org/pypi/twilio) | ||
|
||
A module for using the Twilio REST API and generating valid | ||
[TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - | ||
Twilio Markup Language"). | ||
|
||
## Recent Update | ||
|
||
As of release 6.5.0, Beta and Developer Preview products are now exposed via | ||
the main `twilio-python` artifact. Releases of the `alpha` branch have been | ||
discontinued. | ||
|
||
If you were using the `alpha` release line, you should be able to switch back | ||
to the normal release line without issue. | ||
|
||
If you were using the normal release line, you should now see several new | ||
product lines that were historically hidden from you due to their Beta or | ||
Developer Preview status. Such products are explicitly documented as | ||
Beta/Developer Preview both in the Twilio docs and console, as well as through | ||
in-line code documentation here in the library. | ||
|
||
## Installation | ||
|
||
Install from PyPi using [pip](http://www.pip-installer.org/en/latest/), a | ||
package manager for Python. | ||
|
||
pip install twilio | ||
|
||
Don't have pip installed? Try installing it, by running this from the command | ||
line: | ||
|
||
$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python | ||
|
||
Or, you can [download the source code | ||
(ZIP)](https://github.com/twilio/twilio-python/zipball/master "twilio-python | ||
source code") for `twilio-python`, and then run: | ||
|
||
python setup.py install | ||
|
||
You may need to run the above commands with `sudo`. | ||
|
||
### Migrate from 5.x | ||
Please consult the [official migration guide](https://www.twilio.com/docs/libraries/python/migration-guide) for information on upgrading your application using twilio-python 5.x to 6.x | ||
|
||
## Getting Started | ||
|
||
Getting started with the Twilio API couldn't be easier. Create a | ||
`Client` and you're ready to go. | ||
|
||
### API Credentials | ||
|
||
The `Twilio` needs your Twilio credentials. You can either pass these | ||
directly to the constructor (see the code below) or via environment variables. | ||
|
||
```python | ||
from twilio.rest import Client | ||
|
||
account = "ACXXXXXXXXXXXXXXXXX" | ||
token = "YYYYYYYYYYYYYYYYYY" | ||
client = Client(account, token) | ||
``` | ||
|
||
Alternately, a `Client` constructor without these parameters will | ||
look for `TWILIO_ACCOUNT_SID` and `TWILIO_AUTH_TOKEN` variables inside the | ||
current environment. | ||
|
||
We suggest storing your credentials as environment variables. Why? You'll never | ||
have to worry about committing your credentials and accidentally posting them | ||
somewhere public. | ||
|
||
|
||
```python | ||
from twilio.rest import Client | ||
client = Client() | ||
``` | ||
|
||
### Make a Call | ||
|
||
```python | ||
from twilio.rest import Client | ||
|
||
account = "ACXXXXXXXXXXXXXXXXX" | ||
token = "YYYYYYYYYYYYYYYYYY" | ||
client = Client(account, token) | ||
|
||
call = client.calls.create(to="9991231234", | ||
from_="9991231234", | ||
url="http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient") | ||
print(call.sid) | ||
``` | ||
|
||
### Send an SMS | ||
|
||
```python | ||
from twilio.rest import Client | ||
|
||
account = "ACXXXXXXXXXXXXXXXXX" | ||
token = "YYYYYYYYYYYYYYYYYY" | ||
client = Client(account, token) | ||
|
||
message = client.messages.create(to="+12316851234", from_="+15555555555", | ||
body="Hello there!") | ||
``` | ||
|
||
### Handling a call using TwiML | ||
|
||
To control phone calls, your application needs to output | ||
[TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup | ||
Language"). Use `twilio.twiml.Response` to easily create such responses. | ||
|
||
```python | ||
from twilio.twiml.voice_response import VoiceResponse | ||
|
||
r = VoiceResponse() | ||
r.say("Welcome to twilio!") | ||
print(str(r)) | ||
``` | ||
|
||
```xml | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<Response><Say>Welcome to twilio!</Say></Response> | ||
``` | ||
|
||
### Docker Image B458 td> | ||
|
||
The `Dockerfile` present in this repository and its respective `twilio/twilio-python` Docker image are currently used by Twilio for testing purposes only. | ||
|
||
### Getting help | ||
|
||
If you need help installing or using the library, please check the [Twilio Support Help Center](https://support.twilio.com) first, and [file a support ticket](https://twilio.com/help/contact) if you don't find an answer to your question. | ||
|
||
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason to not format these like:
pip install twilio
orThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No reason. I just restored the old version of this file (and added a couple things that were in the rst variant): https://github.com/twilio/twilio-python/blob/320e3913cce3cc50694d28378d598b0444abe802/README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say to be consistent (e.g. PHP) we should use the pretty code formatting stuff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, but in the preview it still looks good. (shrug)