.. _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 FOR WEB VIEWS

++++++++++++++++++++++++

.. _models:

The :mod:`models` Module

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

.. automodule:: rhodecode.model

   :members:

.. automodule:: rhodecode.model.comment

   :members:

.. automodule:: rhodecode.model.notification

   :members:   

.. _changelog:

Changelog

=========

1.3.4 (**2012-XX-XX**)

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

:status: in-progress

:branch: beta

news

++++

.. _contributing:

Contributing to RhodeCode

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

If you would like to contribute to RhodeCode, please contact me, any help is

greatly appreciated!

Could I request that you make your source contributions by first forking the

RhodeCode repository on bitbucket_

https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to

your forked repository. Please post all fixes into **BETA** branch since your 

fix might be already fixed there and i try to merge all fixes from beta into

stable, and not the other way. Finally, when you are finished making a change, 

.. _installation:

Installation

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

``RhodeCode`` is written entirely in Python. Before posting any issues make 

sure, your not missing any system libraries and using right version of 

libraries required by RhodeCode. There's also restriction in terms of mercurial

clients. Minimal version of hg client known working fine with RhodeCode is

**1.6**. If you're using older client, please upgrade.

Installing RhodeCode from Cheese Shop

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

.. _setup:

Setup

=====

Setting up RhodeCode

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

First, you will need to create a RhodeCode configuration file. Run the 

following command to do this::

    paster make-config RhodeCode production.ini

.. _upgrade:

Upgrade

=======

Upgrading from Cheese Shop

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

.. note::

   Firstly, it is recommended that you **always** perform a database backup 

   before doing an upgrade.

The easiest way to upgrade ``rhodecode`` is to run::

.. _backup:

Backing up RhodeCode

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

Settings

--------

Just copy your .ini file, it contains all RhodeCode settings.

Whoosh index

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

.. _general:

General RhodeCode usage

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

Repository deleting

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

Currently when admin/owner deletes a repository, RhodeCode does not physically

delete a repository from filesystem, it renames it in a special way so it's

not possible to push,clone or access repository. It's worth a notice that,

even if someone will be given administrative access to RhodeCode and will 

delete a repository You can easy restore such action by restoring `rm__<date>`

.. _git_support:

GIT support

===========

Git support in RhodeCode 1.3 was enabled by default. 

Although There are some limitations on git usage.

- No hooks are runned for git push/pull actions.

- logs in action journals don't have git operations

- large pushes needs http server with chunked encoding support.

if you plan to use git you need to run RhodeCode with some

.. _statistics:

Statistics

==========

The RhodeCode statistics system makes heavy demands of the server resources, so

in order to keep a balance between usability and performance, the statistics are

cached inside db and are gathered incrementally, this is how RhodeCode does

this:

With Celery disabled

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

- On each first visit to the summary page a set of 250 commits are parsed and