python-socialtext 0.1.a2

Client library for Socialtext's 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:

• Requirements

• Installation

• Python API

• Contributing

  • Branches

Requirements

1. httplib2

2. 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

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

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.

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.