pynux

python function library for working with nuxeo "REST" APIs.

Install

pip install git+git://github.com/ucldc/pynux.git

or

git clone https://github.com/ucldc/pynux.git
cd pynux
python setup.py install

test

python setup.py test

Command and API Documentation

Requirements

Nuxeo Platform 5.8 with DAM module

REST API

• docs.nuxeo.com
• marketplace
• nuxeoctl mp-install nuxeo-rest-api
• api viewer

Bulk document importer

• docs.nuxeo.com
• marketplace
• nuxeoctl mp-install nuxeo-platform-importer

Configuration

The following is the default configuration:

[nuxeo_account]
user = Administrator
password = Administrator

[rest_api]
base = http://localhost:8080/nuxeo/site/api/v1
X-NXDocumentProperties = dublincore
# for developers on the UCLDC project; use
# X-NXDocumentProperties = dublincore,ucldc_schema,picture

[platform_importer]
base = http://localhost:8080/nuxeo/site/fileImporter

Defaults can be overridden by setting them in ~/.pynuxrc or ./.pynuyxrc.

It may be advisable to chmod 600 .pynuxrc.

License

Copyright © 2014, Regents of the University of California

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the University of California nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.