Metadata-Version: 2.4
Name: render-python
Version: 2.4.0
Summary: python API client to interact with render databases (see https://github.com/saalfeldlab/render)
Author: Forrest Collman, Russel Torres, Eric Perlman, Sharmi Seshamani
Maintainer: Russel Torres
License: BSD 2-Clause License
        
        Copyright (c) 2022, Allen Institute
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. 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.
        
        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 HOLDER 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.
        
Project-URL: Repository, https://github.com/AllenInstitute/render-python.git
Requires-Python: <3.12,>3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: sphinxcontrib-napoleon
Requires-Dist: decorator
Requires-Dist: six
Provides-Extra: test
Requires-Dist: coverage>=4.1; extra == "test"
Requires-Dist: mock>=2.0.0; extra == "test"
Requires-Dist: pep8>=1.7.0; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov>=2.2.1; extra == "test"
Requires-Dist: pytest-pep8>=1.0.6; extra == "test"
Requires-Dist: pytest-xdist>=1.14; extra == "test"
Requires-Dist: flake8>=3.0.4; extra == "test"
Requires-Dist: pylint>=1.5.4; extra == "test"
Requires-Dist: jinja2; extra == "test"
Requires-Dist: ujson; extra == "test"
Provides-Extra: pypi-build
Requires-Dist: build; extra == "pypi-build"
Requires-Dist: twine; extra == "pypi-build"
Dynamic: license-file

.. image:: https://readthedocs.org/projects/render-python/badge/
   :target: http://render-python.readthedocs.io/en/latest/
   :alt: Documentation Status 
.. image:: https://travis-ci.com/AllenInstitute/render-python.svg?branch=master
   :target: https://travis-ci.com/AllenInstitute/render-python
   :alt: Build Status
.. image:: https://codecov.io/gh/AllenInstitute/render-python/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/AllenInstitute/render-python
  
render-python
#############

This is a python API client to interact with `render <https://github.com/saalfeldlab/render>`_ and facilitate python scripting of `tilespec <https://github.com/saalfeldlab/render/blob/master/docs/src/site/markdown/data-model.md>`_ creation

it presently interacts with render via a web-api, though the `client module <renderapi/client.py>`_ aims to interface by calling java client scripts to avoid server-side processing.

Render connection objects created with `renderapi.connect()` can default to environment variables.  Below is an example of the variables which can be sourced and added to, e.g.,  ~/.bashrc or ~/.bash_profile.
::

    export RENDER_HOST="localhost"
    export RENDER_PORT="8080"
    export RENDER_PROJECT="YOURPROJECT"
    export RENDER_OWNER="YOURNAME"
    export RENDER_CLIENT_SCRIPTS=".../render/render-ws-java-client/src/main/scripts"
    export RENDER_CLIENT_SCRIPT="$RENDER_CLIENT_SCRIPTS/run_ws_client.sh"
    export RENDER_CLIENT_HEAP="1G"


`Usage examples for a development Array Tomography workflow <https://github.com/fcollman/render-python-apps>`_ are available.

Documentation 
#############
http://render-python.readthedocs.io/en/latest/

Government Sponsorship
######################
Supported by the Intelligence Advanced Research Projects Activity (IARPA) via Department of Interior / Interior Business Center (DoI/IBC) contract number D16PC00004. The U.S. Government is authorized to reproduce and distribute reprints for Governmental purposes notwithstanding any copyright annotation thereon. Disclaimer: The views and conclusions contained herein are those of the authors and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of IARPA, DoI/IBC, or the U.S. Government.

.. _render :
