Commit 895cb688 by David Robinson

Added installation information to README. Added 'python setup.py test' command.

parent e5b911a4
parse_rest parse_rest
======= ==========
**parse_rest** is a Python client for the [Parse REST API](https://www.parse.com/docs/rest). It provides Python object mapping for Parse objects with methods to save, update, and delete objects, as well as an interface for querying stored objects. **parse_rest** is a Python client for the [Parse REST API](https://www.parse.com/docs/rest). It provides Python object mapping for Parse objects with methods to save, update, and delete objects, as well as an interface for querying stored objects.
Installation
------------
The easiest way to install this package is from [PyPI](http://pypi.python.org/pypi), either using [easy_install](http://packages.python.org/distribute/easy_install.html):
easy_install parse_rest
or [pip](http://pypi.python.org/pypi/pip):
pip install parse_rest
(if you are using a Mac or Linux system you may need to prepend `sudo` to either command).
Alternatively, you can install it from source by downloading or cloning this repository:
git clone git@github.com:dgrtwo/ParsePy.git
and performing the commands:
python setup.py build
python setup.py install
(again you may have to add `sudo` before `python setup.py install`).
You can then test the installation by running:
python setup.py test
Basic Usage Basic Usage
----------- -----------
Let's get everything set up first. You'll need to give **parse_rest** your _Application Id_ and _REST API Key_ (available from your Parse dashboard) in order to get access to your data. Let's get everything set up first. You'll need to give `parse_rest` your `_Application Id_` and `_REST API Key_` (available from your Parse dashboard) in order to get access to your data.
~~~~~ {python} ~~~~~ {python}
>>> import parse_rest >>> import parse_rest
......
from distutils.core import setup from distutils.core import setup, Command
from unittest import TextTestRunner, TestLoader
class TestCommand(Command):
"""Run test suite using 'python setup.py test'"""
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
"""Run test suite in parse_rest.tests"""
try:
from parse_rest import tests
except ImportError:
raise Exception("parse_rest is not installed, cannot run tests")
tests = TestLoader().loadTestsFromNames(["parse_rest.tests"])
t = TextTestRunner(verbosity=1)
t.run(tests)
setup( setup(
name='parse_rest', name='parse_rest',
version='0.0.2012', version='0.1.2012',
description='A client library for Parse.com\'.s REST API', description='A client library for Parse.com\'.s REST API',
url='https://github.com/dgrtwo/ParsePy', url='https://github.com/dgrtwo/ParsePy',
packages=['parse_rest'], packages=['parse_rest'],
maintainer="David Robinson", maintainer="David Robinson",
maintainer_email="dgrtwo@princeton.edu", maintainer_email="dgrtwo@princeton.edu",
cmdclass={"test": TestCommand},
classifiers=[ classifiers=[
'Development Status :: 4 - Beta', 'Development Status :: 4 - Beta',
'Environment :: Web Environment', 'Environment :: Web Environment',
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment