Metadata-Version: 1.0
Name: citeulike_api
Version: 0.1.1dev
Summary: a python api for http://citeulike.org/
Home-page: https://bitbucket.org/howthebodyworks/citeulike_api/src
Author: Dan MacKinlay
Author-email: pypi@email.possumpalace.org
License: BSD
Description: ========================
        CiteULike Client
        ========================
        
        a python client for Citeulike.
        
        This project has just been spun off `possumpalace_kit <https://bitbucket.org/howthebodyworks/possumpalace_kit/src/23e924ba53e8/_lib/citeulike/>`_, my blog engine.
        
        If you notice any problems with paths or dependencies, please file a patch. Or
        just fork it. I'll make you maintainer in all likelihood, as I'm no longer
        using CiteULike so very much, having banned myself from spending too much time working around its foibles.
        
        The CUL "API" was pieced together from forum comments made by the CUL staff over time.
        
        e.g. how to
        
        * `do JSON searches <http://www.citeulike.org/groupforum/2253>`_
        * `edit records by HTML form submission <http://www.citeulike.org/groupforum/700>`_
        * `Edit URLs and JSON fields <http://www.citeulike.org/groupforum/2312>`_
        
        usage
        ======
        
        Here is an example of how i use this from my pavement.py file to write out a bibtex file of all records and download all PDFs:
        
        if options is None: options=globals()['options']
        from citeulike.citeulike_api import CiteULike
        
        outjsonpath = path(options.docroot)/options.bibtex_json_file
        if os.path.isabs(options.attachment_path):
        outpdfpath = path(options.attachment_path)
        else:
        outpdfpath = path(options.docroot)/options.attachment_path
        
        cul = CiteULike(username=options.cul_username,
        password=options.cul_pass,
        json_cache=outjsonpath,
        attachment_path=outpdfpath
        )
        cul.cache_records()
        bibtex_string = cul.render('bibtex')
        with codecs.open(outbibtexpath, 'w', 'utf-8') as bf:
        bf.write(bibtex_string)
        
        TODO
        =====
        
        .. include: TODO.rst
        
        .. This is your project NEWS file which will contain the release notes.
        .. Example: http://www.python.org/download/releases/2.6/NEWS.txt
        .. The content of this file, along with README.rst, will appear in your
        .. project's PyPI page.
        
        News
        ====
        
        0.1.1dev
        ---
        
        *Release date: 16-Mar-2011*
        
        * correct URL to https://bitbucket.org/howthebodyworks/citeulike_api/src
        
        
        
        0.1dev
        ---
        
        *Release date: 16-Mar-2011*
        
        * initial release of the version from https://bitbucket.org/howthebodyworks/possumpalace_kit/src/23e924ba53e8/_lib/citeulike/
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
