``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ 

with a built in push/pull server and full text search.

It works on http/https and has a built in permission/authentication system with 

the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also supports

simple API so it's easy integrable with existing external systems.

RhodeCode is similar in some respects to github or bitbucket_, 

however RhodeCode can be run as standalone hosted application on your own server.

It is open source and donation ware and focuses more on providing a customized, 

self administered interface for Mercurial and GIT repositories. 

RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to 

.. include:: ./docs/screenshots.rst

Incoming / Plans

----------------

- Finer granular permissions per branch, repo group or subrepo

- pull requests and web based merges

- per line file history

- SSH based authentication with server side key management

- Commit based built in wiki system

- More statistics and graph (global annotation + some more statistics)

- Other advancements as development continues (or you can of course make 

  additions and or requests)

License

-------

``RhodeCode`` is released under the GPLv3 license.

Mailing group Q&A

.. _api:

API

===

Starting from RhodeCode version 1.2 a simple API was implemented.

There's a single schema for calling all api methods. API is implemented

with JSON protocol both ways. An url to send API request in RhodeCode is

<your_server>/_admin/api

API access can also be turned on for each view decorated with `@LoginRequired`

decorator. To enable API access simple change standard login decorator into

`@LoginRequired(api_access=True)`. After such a change view can be accessed

by adding a GET parameter to url `?api_key=<api_key>`. By default it's only

enabled on RSS/ATOM feed views.

All clients are required to send JSON-RPC spec JSON data::

    {   

        "id:<id>,

        "api_key":"<api_key>",

        "method":"<method_name>",

        "args":{"<arg_key>":"<arg_val>"}

    }

Example call for autopulling remotes repos using curl::

    curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'

API Reference

=============

.. toctree::

   :maxdepth: 3

   models

   api 

.. _models:

The :mod:`models` Module

========================

.. automodule:: rhodecode.model

   :members:

.. automodule:: rhodecode.model.permission

   :members:

.. automodule:: rhodecode.model.repo

   :members:   

.. automodule:: rhodecode.model.scm

   :members:

.. automodule:: rhodecode.model.user

   :members:      

.. _index:

.. include:: ./../README.rst

**Installation:**

.. toctree::

   :maxdepth: 1

   installation

   setup

   upgrade

**Usage**

.. toctree::

   :maxdepth: 1

   usage/general

   usage/enable_git

   usage/statistics

   usage/backup

**Develop**

.. toctree::

   :maxdepth: 1

   contributing

   changelog

**API**

.. toctree::

   api/index

Other topics

------------

* :ref:`genindex`

* :ref:`search`

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

.. _python: http://www.python.org/

# -*- coding: utf-8 -*-

"""

    rhodecode.model.notification

    Model for notifications

    :created_on: Nov 20, 2011

    :author: marcink

    :copyright: (C) 2010-2012 Marcin Kuzminski <marcin@python-works.com>

    :license: GPLv3, see COPYING for more details.

"""

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 3 of the License, or