8000 Migrate readme to rst and load it in with setup.py by cjcodes · Pull Request #417 · twilio/twilio-python · GitHub
[go: up one dir, main page]

Skip to content

Migrate readme to rst and load it in with setup.py #417

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 4 commits into from
May 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 0 additions & 129 deletions README.md

This file was deleted.

156 changes: 156 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
twilio-python
=============

.. image:: https://secure.travis-ci.org/twilio/twilio-python.png?branch=master
:target: http://travis-ci.org/twilio/twilio-python
.. image:: https://img.shields.io/pypi/v/twilio.svg
:target: https://pypi.python.org/pypi/twilio
.. image:: https://img.shields.io/pypi/pyversions/twilio.svg
:target: 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/>`__.

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>`__ 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

Feedback
--------

Report any feedback or problems with this Release Candidate to the
`Github Issues <https://github.com/twilio/twilio-python/issues>`__ for
twilio-python.

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.

.. code:: 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.

.. code:: python

from twilio.rest import Client
client = Client()

Make a Call
~~~~~~~~~~~

.. code:: 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
~~~~~~~~~~~

.. code:: 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/>`__. Use
``twilio.twiml.Response`` to easily create such responses.

.. code:: python

from twilio.twiml.voice_response import VoiceResponse

r = VoiceResponse()
r.say("Welcome to twilio!")
print(str(r))

.. code:: xml

<?xml version="1.0" encoding="utf-8"?>
<Response><Say>Welcome to twilio!</Say></Response>
16 changes: 5 additions & 11 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
with open('twilio/__init__.py') as f:
exec(f.read())

with open('README.rst') as f:
long_description = f.read()

# To install the twilio-python library, open a Terminal shell, then run this
# file by typing:
#
Expand Down Expand Up @@ -51,14 +54,5 @@
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Communications :: Telephony",
],
long_description = """\
Python Twilio Helper Library
----------------------------

DESCRIPTION
The Twilio REST SDK simplifies the process of making calls using the Twilio REST API.
The Twilio REST API lets to you initiate outgoing calls, list previous calls,
and much more. See https://www.github.com/twilio/twilio-python for more information.

LICENSE The Twilio Python Helper Library is distributed under the MIT
License """ )
long_description = long_description
)
0