Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Python binding for the Socialtext REST API

Project description

This is a client for Socialtext’s REST API. The goal of this project is to provide an extensible library that helps you focus on building applications that leverage the power of Socialtext instead of worrying about HTTP methods and status codes.

You can read the documentation at: http://python-socialtext.readthedocs.org/

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(url=ST_URL, username=USERNAME, password=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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-socialtext, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size python-socialtext-0.2.2.tar.gz (65.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page