skip to navigation
skip to content

Not Logged In

marlin 0.97

A fast and easy ReST API on top of redis

Latest Version: 0.986

Marlin
======

#### a fast, frill-free REST API with ZERO setup time is too interesting.


```bash

pip install marlin

marlin-server start // starts the REST API with default settings on port 5000

marlin-server stop // stops the server

marlin-server restart // restart the server

marlin-server live // starts a server on DEBUG mode, __NOT__ as a daemon
```



| METHOD | URL | RESPONSE | DESCRIPTION |
| ------------- |:--------------------------------: | :----------:| :--------------------------------------:|
| GET | /api/v1/<model>/?start=1&end=10 |[data] (0-10)| returns the 1-10 elements in the <model>|
| GET | /api/v1/<model>/1 | data item | returns the element with id 1 |
| GET | /ping/ | 200/500 | check if service is up and connected |
| POST | /api/v1/<model>/ | [data] | adds data to the model |
| PUT | /api/v1/<model>/1/ | [data] | edit data |
| DELETE | /api/v1/<model>/1 | 200 | delete the data item |
| DELETE | /api/v1/<model>/ | - | delete complete data in model |
| DELETE | /api/v1/<model>/&force=1 | - | delete and reset model (starts with id=1|



__marlin.config__

```
[SERVER]

DEBUG = True

PID_FILE = /tmp/marlin.pid

LOG_FILE = /tmp/marlin.log

SERVER_PORT = 5000

[REDIS]

REDIS_SERVER = localhost

REDIS_PORT = 6379

API_PREFIX = /api/

[APP]

APP_NAME = marlin
```

For custom configuration, just create a __marlin.config__ on the directory from where you are starting marlin-server.  
File Type Py Version Uploaded on Size
marlin-0.97.tar.gz (md5) Source 2014-04-18 37KB
  • Downloads (All Versions):
  • 26 downloads in the last day
  • 118 downloads in the last week
  • 832 downloads in the last month