Skip to main content
Help us improve Python packaging – donate today!

A fast and easy ReST API on top of redis

Project Description

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.

Release history Release notifications

History Node

0.986

History Node

0.985

History Node

0.984

History Node

0.982

History Node

0.981

History Node

0.981c

History Node

0.981b

History Node

0.979

History Node

0.961

This version
History Node

0.97

History Node

0.96

History Node

0.95

History Node

0.94

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
marlin-0.97.tar.gz (38.6 kB) Copy SHA256 hash SHA256 Source None Apr 18, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page