Giter Club home page Giter Club logo

icouch's Introduction

ICouch

Build Status Coverage Status Hex.pm API Docs

Description

ICouch is a CouchDB client for Elixir using ibrowse for HTTP transfer.

JSON encoding/decoding is provided by Poison.

ICouch claims to be more "Elixir Style" than other implementations based on couchbeam and offers a more rigid changes follower tested against vanilla CouchDB and Cloudant. That said, many calls might look and behave similarly like couchbeam's since the intent is often the same. However, parameter order and types will differ in most cases; most notably maps are used instead of JSON keyword lists.

Another innovation is, that documents are represented as Elixir structs. These offer a way to conveniently manage attachments in binary form and also implement the Access behavior and Enumerable protocol for easy handling of a document's fields.

Status

This project is currently in beta phase.

ToDo's:

  • Implement view streaming
  • Implement one-shot changes streaming
  • Finish documentation
  • Write more tests

Installation

Add ICouch to your list of dependencies in mix.exs:

def deps do
  [{:icouch, "~> 0.5"}]
end

Usage

(todo)

Author

Patrick Schneider / MeetNow! GmbH

License

Copyright (c) 2017,2018 MeetNow! GmbH

ICouch source code is released under Apache 2 License.

Check the LICENSE file for more information.

icouch's People

Contributors

p2k avatar

Watchers

Olafur Arason avatar James Cloos 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.