Read Me

Contact
=======

Albrecht Schmiedel, atms at cadopy.org


License 
=======

GPL


Note
====

Cadopy is not ready for use. There has not yet been any
release. This is ongoing work.


Overview
========

See doc/overview.txt.


Dependencies
============

- OS: Tested only under Linux. But essentially there is nothing
  OS-specific. Plugin 'files' probably has to be modified because
  it uses symbolic links.

- Python: Python 2.4 or better

- Webserver: Cherrypy 2.1.0-beta (No other version will
  work without changes!)

- Database: mysql 3.23.55 (Probably newer versions will work, not
  tested)


Installation
============

- Create a database in mysql 

- Edit example.conf:

  - database parameters

  - host, port

  - Specify empty directory for importing files.
    cado.file_dir and staticFilter.dir in the /files section
    should have the same value.


Starting the server
===================

- python start.py --config example.conf [--initialize]

- use the --initialize option to initialize the database (and
  lose all data!)

- Access server:

  http://<host>:<port>/find


Interacting with the repository
===============================

- python -i interactive.py --config example.conf [--initialize]

- Use the --initialize option to initialize the database (and
  lose all data!)

- r will be bound to the repository object and s to the schema object.
  see cado/repository.py and cado/schema.py for what's available.


Running tests
=============

- See cado/test/README.txt.