Metadata-Version: 1.0
Name: python-socialtext
Version: 0.1.a2
Summary: Client library for Socialtext's ReST API
Home-page: UNKNOWN
Author: Justin Murphy, The Hanover Insurance Group
Author-email: ju1murphy@hanover.com
License: UNKNOWN
Description: Python bindings for the Socialtext ReST API
        ===========================================
        
        This is a client for Socialtext's ReST API. We are currently in the alpha stage for the first release. The API only supports basic operations for a few resources, but it is a good start! Please test thoroughly before use in a production environment.
        
        .. contents:: Contents:
           :local:
        
        Requirements
        ------------
        
        1. httplib2__
        2. poster__
        
        __ http://code.google.com/p/httplib2/
        __ http://atlee.ca/software/poster/
        
        Installation
        ------------
        
        You can install python-socialtext using pip or easy_install::
        
            pip install python-socialtext
        
            # or
            
            easy_install python-socialtext
        
        The tests use nose__ and can be run using::
        
        	python setup.py test
        
        	# or
        
        	nosetests
        
        __ http://code.google.com/p/python-nose/
        
        You can use Sphinx__ to build the documentation locally::
        
            cd docs
            make html # windows: use make.bat
        
            # open the _build/index.html document in your browser
        
        __ http://sphinx.pocoo.org/
        
        Python API
        ----------
        
        Quick start::
        
            from socialtext import Socialtext
        
            st = Socialtext(ST_URL, USERNAME, PASSWORD)
        
            st.signals.create("This is a signal from the API!")
            <Signal: 1234>
        
            signal.delete()
        
            st.pages.list("ws-name")
            <Page: test_page>, <Page: test_page_2>, <Page: test_page_3>
        
            ws = st.workspaces.get("ws-name")
            st.pages.list(ws)
            <Page: test_page>, <Page: test_page_2>, <Page: test_page_3>
        
        Contributing
        ------------
        
        Development takes place on Github__. You can file bug reports and pull requests there.
        
        __ https://github.com/hanover/python-socialtext
        
        Branches
        ````````
        
        This project follows the git-flow__ branch methodology. So, there will always be two branches in the repository:
        
            master
                The stable, production branch.
            
            develop
                Active development work towards the next release. All pull requests will be merged into this branch.
        
        __ https://github.com/nvie/gitflow
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
