Not Logged In

ocdev 0.0.13

========================ownCloud developer tools========================This is a Python 3 library. Every pip and python command in the following codesamples should be, if needed, replaced by the appropriate command on your system (e.g. python3, pip3)

The **-m** option tells python to run the **ocdev/__main__.py** file. This is needed to have working imports in both installed and local versions.

.. note:: If the library is also installed the installed version imports will be used and local changes will be ignored. **Make sure to uninstall the global version first before running the local version**!

Installation============If **Python 3** and **pip** are not yet installed on the system, install it from your package manager, e.g.::

sudo apt-get install python3 python3-pip

Verify the Python version using::

python --version

If it outputs **Python 3.2 or lower** (e.g. on **Ubuntu 12.04**) you will **need to install jinja from your package manager first**, e.g.::

sudo apt-get install python3-jinja2

Then install the tool::

sudo pip3 install ocdev

For the **setup** command, **git** has to be installed.

Updating========To update the library run::

sudo pip3 install --upgrade ocdev

Setting up a development environment====================================To set up your development environment run::

* **--dir**: sets the name of the owncloud directory, defaults to core/* **--branch**: sets the branch which should be cloned, defaults to master* **--type**: sets the type that should be cloned, ssh or https. Defaults to https since you need access to the repository to use ssh

* **--version**: defaults to 0.0.1* **--description**: sets the app description in the appinfo/info.xml* **--homepage**: sets the author's homepage in the AUTHORS.md file* **--license**: agpl or mit, defaults to agpl* **--owncloud**: the minimum ownCloud version, defaults to the currently active version* **--output**: The directory where the generated files should be written to. Defaults to the current directory

For a more verbose output run::

ocdev startapp -h

Setting up a test instance for continous integration====================================================To set up a test instance for continous integration (e.g. on Travis-CI) run::

ocdev setup core cd core ocdev ci mysql

The following databases can be chosen:

* **mysql*** **sqlite*** **postgresql**

The script requires php to be available from commandline.

Interfacing with the app generator==================================To use the app generator in your python app use::