Skip to content

Commit 0fddbbe

Browse files
author
Daniel J Holmes (jaitaiwan)
committed
Minor copy edits
1 parent ef42e4b commit 0fddbbe

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

+20-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
11
[![Build Status](https://travis-ci.org/joestump/python-oauth2.svg)](https://travis-ci.org/joestump/python-oauth2)
22

33
# Overview
4-
5-
This code was originally forked from [Leah Culver and Andy Smith's oauth.py code](http://github.com/leah/python-oauth/). Some of the tests come from a [fork by Vic Fryzel](http://github.com/shellsage/python-oauth), while a revamped Request class and more tests were merged in from [Mark Paschal's fork](http://github.com/markpasc/python-oauth). A number of notable differences exist between this code and its forefathers:
6-
7-
* 100% unit test coverage.
8-
* The <code>DataStore</code> object has been completely ripped out. While creating unit tests for the library I found several substantial bugs with the implementation and confirmed with Andy Smith that it was never fully baked.
9-
* Classes are no longer prefixed with <code>OAuth</code>.
10-
* The <code>Request</code> class now extends from <code>dict</code>.
11-
* The library is likely no longer compatible with Python 2.3.
12-
* The <code>Client</code> class works and extends from <code>httplib2</code>. It's a thin wrapper that handles automatically signing any normal HTTP request you might wish to make.
4+
python-oauth2 is a python oauth library fully compatible with python versions: 2.6, 2.7, 3.3 and 3.4. This library is depended on by many other downstream packages such as Flask-Oauth.
135

146
# Installing
157

@@ -21,4 +13,22 @@ We recommend using [virtualenv](https://virtualenv.pypa.io/en/latest/).
2113

2214
# Examples
2315

24-
Examples can be found in the [wiki](./wiki/)
16+
Examples can be found in the [wiki](./wiki/)
17+
18+
# Running tests
19+
You can run tests using the following at the command line:
20+
21+
$ pip install -r requirements.txt
22+
$ python setup.py test
23+
24+
25+
# History
26+
27+
This code was originally forked from [Leah Culver and Andy Smith's oauth.py code](http://github.com/leah/python-oauth/). Some of the tests come from a [fork by Vic Fryzel](http://github.com/shellsage/python-oauth), while a revamped Request class and more tests were merged in from [Mark Paschal's fork](http://github.com/markpasc/python-oauth). A number of notable differences exist between this code and its forefathers:
28+
29+
* 100% unit test coverage.
30+
* The <code>DataStore</code> object has been completely ripped out. While creating unit tests for the library I found several substantial bugs with the implementation and confirmed with Andy Smith that it was never fully baked.
31+
* Classes are no longer prefixed with <code>OAuth</code>.
32+
* The <code>Request</code> class now extends from <code>dict</code>.
33+
* The library is likely no longer compatible with Python 2.3.
34+
* The <code>Client</code> class works and extends from <code>httplib2</code>. It's a thin wrapper that handles automatically signing any normal HTTP request you might wish to make.

0 commit comments

Comments
 (0)