Riakkit


Welcome to Riakkit's Website

As promised, I have made this website with the help of funnel, which is another project that I'm working on. This is basically going to be a cleaner website than just the API reference, which the latest tutorial and the API documentation.

So what is riakkit? Riakkit exists to fill the void that is the lack of a full featured ORM for Riak and Python. Inspired by Mongokit and Couchdbkit, Riakkit is the version for Riak.

This project is developed to make my life easier with another project that I'm working on. Riakkit is being extensively tested on that project, so hopefully it will be as bug free as it could be if I'm the only maintainer.

The project is licensed under LGPLv3, which allows link in to any program you want. However, if you wish to modify Riakkit, please consider forking the project on github and help with the development effort there.

Of course, you should donate to me to keep this project going as I'm just a poor student :P

Donate to me to keep this going!

Also, shout outs to the contributors to this project! You can view them at: https://github.com/ultimatebuster/riakkit/graphs/contributors

Most of these right now are small contributions fixing small errors. I highly encourage you to join the core development effort if you can as this is pretty much the only project of its kind for Riak and Python.

We also have a discussions mailing list/google groups now. It's available here: https://groups.google.com/forum/#!forum/riakkit or riakkit@googlegroups.com if you're signed up.

Getting Started

To install Riakkit, execute pip install riakkit to get the latest "stable". However, this project is in the stage where the code directly from the git repo will be less buggy than the pypi version. Download the latest repo version via git clone and python setup.py install. Then, you can take a look at the Get Started Guide.

Additional Resources

  1. Riakkit API References
  2. Basho's wiki
  3. Riakkit Github
  4. Riak-Python

Of course, you should always donate a bit to me to help keep this project going.

Donate to me to keep this going!