Code Monkey home page Code Monkey logo

crest's Introduction

Crest

A simple REST client for Python.

Installation

Install Crest with pip:

$ pip install python-crest

Install development version from GitHub:

$ git clone https://github.com/RussellLuo/crest.git
$ cd crest
$ python setup.py install

Getting Started

Create an API resource:

from crest import Resource

# a simple API
api = Resource('http://example.com/api')

# an API required authentication
api = Resource('http://example.com/api', auth=('username', 'password'))

# GET http://example.com/api
api.get()

Get a resource within the API:

users = api.users

# GET http://example.com/api/users
users.get()

# GET http://example.com/api/users?name=russell
users.get(params={'name': 'russell'})

# POST http://example.com/api/users (payload: {"name": "russell"})
users.post(json={'name': 'russell'})

# GET http://example.com/api/users/1
users[1].get()

# PATCH http://example.com/api/users/1 (payload: {"name": "russell"})
users[1].patch(json={'name': 'russell'})

Get a sub resource of users:

operations = users[1].operations

# GET http://example.com/api/users/1/operations
operations.get()

# GET http://example.com/api/users/1/operations/1
operations[1].get()

Thanks

Crest is based on kennethreitz's requests, and is inspired by adnam's resources. Thank you guys!

crest's People

Contributors

russellluo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.