Skip to main content

# libgreader readme libgreader is a Python library for authenticating and interacting with the unofficial Google Reader API. It currently supports all major user authentication methods (ClientLogin, OAuth, OAuth2) and aims to simplify the many features that Google Reader offers. RSS ain’t dead yet!

Licensed under the MIT license: [http://www.opensource.org/licenses/mit-license.php]()

## Features

  • Support for all Google recommended authentication methods, for easy integration with existing web or desktop applications

  • Explanation of most of the Google Reader API endpoints, which Google has never really opened up

  • Convenient functions and models for working with those endpoints

  • A modest integration test suite!

## Usage

It’s as simple as:

>>> from libgreader import GoogleReader, ClientAuthMethod, Feed
>>> auth = ClientAuthMethod('YOUR USERNAME','YOUR PASSWORD')
>>> reader = GoogleReader(auth)
>>> print reader.getUserInfo()
{u'userName': u'Foo', u'userEmail': u'libgreadertest@gmail.com', u'userId': u'16058940398976999581', u'userProfileId': u'100275409503040726101', u'isBloggerUser': False, u'signupTimeSec': 0, u'isMultiLoginEnabled': False}`

For more examples with all of the authentication methods, see the [USAGE file](https://github.com/askedrelic/libgreader/blob/master/USAGE.md).

## Installation

libgreader is on pypi at [http://pypi.python.org/pypi/libgreader/](http://pypi.python.org/pypi/libgreader/)

$ pip install libgreader

or

$ easy_install libgreader

## Testing and Contribution

Want to test it out or contribute some changes?

First, fork the repository on Github to make changes on your private branch. Then, create a dev environment using a virtualenv:

$ pip install virtualenvwrapper $ mkvirtualenv venv-libgreader –no-site-packages

Clone your fork and install the development requirements, required for running the tests:

$ pip install -r dev_requirements.txt

Then run the tests:

$ python setup.py test

Now hack away! Write tests which show that a bug was fixed or that the feature works as expected. Then send a pull request and bug me until it gets merged in and published.

## Thanks

Originally created with help from:

[http://blog.martindoms.com/2009/08/15/using-the-google-reader-api-part-1/]()

[http://code.google.com/p/pyrfeed/wiki/GoogleReaderAPI]()

[http://groups.google.com/group/fougrapi]()

Since then, [many have contributed to the development of libgreader](https://github.com/askedrelic/libgreader/blob/master/AUTHORS.md).

#History

##WIP *

##v0.6 - 2012/08/10 * OAuth2 support * Deprecating OAuth support * Added auth support for Google App Engine with GAPDecoratorAuthMethod * Internal code re-organization

##v0.5 - 2010/12/29 * Added project to PyPi, moved to real Python project structure * Style cleanup, more tests

##v0.4 - 2010/08/10 Lot of improvements :

  • Manage special feeds (reading-list, shared, starred, friends…)

  • Manage categories (get all items, mark as read)

  • Manage feeds (get items, unread couts, mark as read, “fetch more”)

  • Manage items (get and mark read, star, share)

and:

  • oauth2 not required if you don’t use it

  • replacing all xml calls by json ones

##v0.3 - 2010/03/07 * All requests to Google use HTTPS * CLeaned up formatting, should mostly meet PEP8 * Fixed random unicode issues * Added licensing

##v0.2 - 2009/10/27 * Moved all get requests to private convenience method * Added a few more basic data calls

##v0.1 - 2009/10/27 * Connects to GR and receives auth token correctly. * Pulls down subscription list.

Metadata

Release files for libgreader 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for libgreader 0.6.0
File Size Uploaded Provenance Actions
libgreader-0.6.0.tar.gz 16.3 kB Without provenance Details for libgreader-0.6.0.tar.gz

Release files / libgreader-0.6.0.tar.gz

Download URL libgreader-0.6.0.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c219fe2277244c116ad6300e1843e9a0e6c38865713c3bcc5dc80329997d0af1
BLAKE2b-256 checksum
How to use checksums
4db296657e0a7bc2b3628c8a708bf3f193f942012152e63ddbfe905acf59a672
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for libgreader 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page