soundcloud / python-api-wrapper

A Python wrapper for the SoundCloud API that works with Django and Google App Engine

This URL has Read+Write access

name age
history
message
file .gitignore Wed Sep 09 16:25:22 -0700 2009 look at ChangeLog [Diez Roggisch]
file AUTHORS Wed Feb 25 05:22:38 -0800 2009 Reimport from svn repo. [pht]
file ChangeLog Wed Sep 09 16:25:22 -0700 2009 look at ChangeLog [Diez Roggisch]
file LICENSE Tue Feb 17 08:41:14 -0800 2009 first commit [soundcloud]
file README Wed Feb 25 05:22:38 -0800 2009 Reimport from svn repo. [pht]
file bootstrap.py Thu Sep 17 04:26:14 -0700 2009 x-www-form-urlencoded PUT requests should not h... [hannestyden]
directory docs/ Wed Sep 09 16:25:22 -0700 2009 look at ChangeLog [Diez Roggisch]
directory oauth/ Wed Feb 25 05:22:38 -0800 2009 Reimport from svn repo. [pht]
directory scapi/ Thu Sep 17 04:26:14 -0700 2009 x-www-form-urlencoded PUT requests should not h... [hannestyden]
file setup.py Wed Sep 09 16:25:22 -0700 2009 look at ChangeLog [Diez Roggisch]
file test.ini Thu Sep 17 04:26:14 -0700 2009 x-www-form-urlencoded PUT requests should not h... [hannestyden]
README
Running tests
=============

The **SCAPI** comes with a small testsuite. It can be run automatically through either setuptools_ 
or nose_.

Configuring tests
-----------------

Before you can run the tests, you need to configure them. You do this using the `test.ini` file in the
root of python **SCAPI** workingcopy.

Running tests through setuptools
--------------------------------

You can run the whole testsuite through setuptools_ by doing ::

  host:~/SoundCloudAPI deets$ python setup.py test

Running tests through nose
--------------------------

If you want a more fine-grained control over which tests to run, you can use the `nosetests`-commandline tool.

Then to run individual tests, you can e.g. do::

  host:~/SoundCloudAPI deets$ nosetests -s scapi.tests.scapi_tests:SCAPITests.test_setting_permissions


See the nose_-website for more options.



.. _nose: http://somethingaboutorange.com/mrl/projects/nose/
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
.. _ConfigObj: http://www.voidspace.org.uk/python/configobj.html


Creating the API-docs
=====================

Do::
   epydoc -v --name="SoundCloud API" --html -o docs/api scapi --exclude="os|mimetypes|urllib2|exceptions|mimetools"