Skip to content

Commit 3022b1a

Browse files
Charles MoadCharles Moad
Charles Moad
authored and
Charles Moad
committed
added requirements and install instructions
1 parent bda30f3 commit 3022b1a

File tree

3 files changed

+35
-13
lines changed

3 files changed

+35
-13
lines changed

README.md

+26-11
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,12 @@ ExactTarget Fuel SDK for Python
66

77
The Fuel SDK for Python provides easy access to ExactTarget's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to ExactTarget functionality via common collection types such as array/hash.
88

9-
## Requirements
10-
11-
Python 2.7.3
12-
13-
Libraries:
14-
15-
* pyjwt 0.1.5
16-
* requests 1.1.0
17-
* suds 0.4
9+
## Installation
1810

19-
The quickest way to install the required libraries is to use pip and tell it to load the libraries listed in the `requirements.txt` file (see below). Pip is a tool for installing and managing Python packages and is available at https://pypi.python.org/pypi/pip.
11+
The Fuel SDK for python can be easily installed from the [Python Package Index](https://pypi.python.org/pypi) using the [pip](https://pip.readthedocs.org) command. Pip is a tool for installing and managing Python packages.
2012

2113
```
22-
pip install -r requirements.txt
14+
pip install FuelSDK
2315
```
2416

2517
## Getting Started
@@ -139,6 +131,29 @@ Sample List:
139131
* [TriggeredSend](https://github.com/ExactTarget/FuelSDK-Python/blob/master/objsamples/sample_triggeredsend.py)
140132
* [UnsubEvent](https://github.com/ExactTarget/FuelSDK-Python/blob/master/objsamples/sample_unsubevent.py)
141133

134+
## Development on FuelSDK-Python
135+
136+
If you would like to help contribute to the FuelSDK-Python project, checkout the code from the [GitHub project page](https://github.com/ExactTarget/FuelSDK-Python). The use of [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/) is highly recommended. After installing virtualenvwrapper you can run the following commands to setup a sandbox for development.
137+
138+
```
139+
git clone git@github.com:ExactTarget/FuelSDK-Python.git
140+
mkvirtualenv FuelSDK-Python
141+
cd FuelSDK-Python
142+
pip install -r requirements.txt
143+
```
144+
145+
You will then have a sandbox which includes all dependencies for doing development on FuelSDK-Python.
146+
147+
## Requirements
148+
149+
Python 2.7.x
150+
151+
Libraries:
152+
153+
* pyjwt
154+
* requests
155+
* suds
156+
142157
### Custom Suds Changes (Deprecated)
143158

144159
**Note**: Suds is now patched at runtime when importing the FuelSDK. You no longer need to edit the library. Please be aware of the change.

requirements.txt

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
-e git+git@github.com:ExactTarget/FuelSDK-Python.git@bda30f3bcd6215efb8fe7b49adb9caacba36fd4c#egg=FuelSDK-master
2+
PyJWT==0.1.8
13
distribute==0.6.35
2-
pyjwt==0.1.5
3-
requests==1.1.0
4+
requests==2.2.1
45
suds==0.4
6+
wsgiref==0.1.2

setup.py

+5
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414
packages=['FuelSDK'],
1515
url='https://github.com/ExactTarget/FuelSDK-Python',
1616
license='MIT',
17+
install_requires=[
18+
'pyjwt==0.1.8',
19+
'requests==2.2.1',
20+
'suds==0.4',
21+
],
1722
classifiers=[
1823
'Development Status :: 5 - Production/Stable',
1924
'Intended Audience :: Developers',

0 commit comments

Comments
 (0)