Metadata-Version: 1.1
Name: pulsar-galaxy-lib
Version: 0.9.0
Summary: Distributed job execution application built for Galaxy (http://galaxyproject.org/).
Home-page: https://github.com/galaxyproject/pulsar
Author: Galaxy Project
Author-email: jmchilton@gmail.com
License: Apache License 2.0
Description: .. figure:: https://galaxyproject.org/images/galaxy-logos/pulsar_transparent.png
           :alt: Pulsar Logo
        
        .. image:: https://readthedocs.org/projects/pulsar/badge/?version=latest
           :target: http://pulsar.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        .. image:: https://badge.fury.io/py/pulsar-app.svg
           :target: https://pypi.python.org/pypi/pulsar-app/
           :alt: Pulsar on the Python Package Index (PyPI)
        .. image:: https://travis-ci.org/galaxyproject/pulsar.png?branch=master
           :target: https://travis-ci.org/galaxyproject/pulsar
           :alt: Build Status
        .. image:: https://coveralls.io/repos/galaxyproject/pulsar/badge.png?branch=master
           :target: https://coveralls.io/r/galaxyproject/pulsar?branch=master
           :alt: Test Coverage
        
        This project is a Python server application that allows a `Galaxy
        <http://galaxyproject.org>`_ server to run jobs on remote systems (including
        Windows) without requiring a shared mounted file systems. Unlike traditional
        Galaxy job runners - input files, scripts, and config files may be transferred
        to the remote system, the job is executed, and the results are transfered back
        to the Galaxy server - eliminating the need for a shared file system.
        
        Full documentation for the project can be found on `Read The Docs
        <https://pulsar.readthedocs.io/>`_.
        
        ------------------
        Configuring Galaxy
        ------------------
        
        Galaxy job runners are configured in Galaxy's ``job_conf.xml`` file. Some small
        examples of how to configure this can be found `here
        <https://pulsar.readthedocs.org/en/latest/galaxy_conf.html>`__, but be sure
        to checkout ``job_conf.xml.sample_advanced`` in your Galaxy code base or on
        `Github
        <https://github.com/galaxyproject/galaxy/blob/master/config/job_conf.xml.sample_advanced>`_
        for complete information.
        
        ------------------
        Quickstart
        ------------------
        
        Full details on different ways to install Pulsar can be found in the `install
        section <https://pulsar.readthedocs.org/en/latest/install.html>`__ of the
        documentaiton, but if your machine has the proper Python dependencies
        available it can be quickly download and a test job run with.
        
        ::
        
            mkdir pulsar
            cd pulsar
            virtualenv venv
            . venv/bin/activate # .venv\Scripts\activate if Windows
            pip install pulsar-app
            pulsar-config 
            pulsar --daemon # just pulsar if Windows
            pulsar-check # runs a test job
        
        The `configuration documentation
        <https://pulsar.readthedocs.org/en/latest/configure.html>`__
        has many details on securing your Pulsar server and enabling advanced features
        such as cluster integration and message queue communication.
        
        -----------------------
        Development and Testing
        -----------------------
        
        The recommended approach to setting up a development environment for Pulsar on
        Linux or Mac OS X is rougly as follows::
        
            git clone https://github.com/galaxyproject/pulsar
            cd pulsar
            virtualenv .venv
            . .venv/bin/activate # .venv\Scripts\activate if Windows
            pip install -r requirements.txt
            pip install -r dev-requirements.txt
        
        This project is distributed with unit and integration tests (many of which
        will not run under Windows), the following command will install the needed
        python components to run these tests. The following command will then run
        these tests::
        
            make tests
        
        The following command will then produce a coverage report
        corresponding to this test and place it in the ``coverage_html_report``
        subdirectory of this project.::
        
            coverage html
        
        Checkout the `Contributing
        <https://pulsar.readthedocs.org/en/latest/contributing.html>`_ documentation
        for many more details on developing and contributing to Pulsar.
        
        Please note that this project is released with a `Contributor Code of Conduct 
        <https://pulsar.readthedocs.org/en/latest/conduct.html>`__. By participating
        in this project you agree to abide by its terms.
        
        
        
        
        History
        -------
        
        .. to_doc
        
        ---------------------
        0.9.0 (2019-04-12)
        ---------------------
            
        * Add configuration parameter to limit stream size read from disk. `Pull
          Request 157`_
        * Pass full job status for failed and lost jobs. `Pull Request 159`_
        * Improve message handling if problems occur during job setup/staging. `Pull
          Request 160`_
        * Rework preprocessing job state to improve restartability and reduce job loss.
          **This change should be applied while no jobs are running.**
          `Pull Request 164`_
        * Add support for overriding config through environment variables (thanks to
          @nuwang). `Pull Request 165`_
        * Minor docs updates (thanks to @afgane). `Pull Request 170`_
        * Python 3 fixes in Pulsar client (thanks to @mvdbeek). `Pull Request 172`_
        
        ---------------------
        0.8.3 (2018-02-08)
        ---------------------
        
        * Create universal wheels to enable Python 3 support when installing from PyPI
          (thanks to @nsoranzo).
          `Pull Request 156`_
        
        ---------------------
        0.8.1 (2018-02-08)
        ---------------------
        
        * Update link for logo image. `Pull Request 145`_
        * Minor error and log message typos (thanks to @blankenberg).
          `Pull Request 146`_, `Pull Request 153`_
        * Fixes/improvements for catching quoted tool files. `Pull Request 148`_
        * Fix config sample parsing so run.sh works out of the box.
          `Pull Request 149`_
        
        ---------------------
        0.8.0 (2017-09-21)
        ---------------------
        
        * Support new features in Galaxy job running/scripting so that Pulsar respects
          ``$GALAXY_VIRTUAL_ENV`` and ``$PRESERVE_GALAXY_ENVIRONMENT``. Fix remote
          metadata in cases where the tool environment changes the ``python`` on
          ``$PATH``. `Pull Request 137`_
        * Precreate Galaxy tool outputs on the remote before executing (fixes a bug
          related to missing output files on stage out). `Pull Request 141`_
        * Support the remote_transfer file action without setting the
          ``jobs_directory`` destination param `Pull Request 136`_
        * Fix invalid character in job managers documentation (thanks to @mapa17).
          `Pull Request 130`_
        * Fix ``conda_auto_*`` option resolution and include a sample
          ``dependency_resolvers_conf.xml`` (thanks to @mapa17). `Pull Request 132`_
        * Fix tox/Travis tests. `Pull Request 138`_, `Pull Request 139`_,
          `Pull Request 140`_
        * Fix a bug with AMQP acknowledgement. `Pull Request 143`_
        
        ---------------------
        0.7.4 (2017-02-07)
        ---------------------
        
        * Fix Conda resolution and add a test case. 11ce744_
        * Style fixes for updated flake8 libraries. 93ab8a1_, 3573341_
        * Remove unused script. 929bffa_
        * Fixup README. 629fdea_
            
        
        ---------------------
        0.7.3 (2016-10-31)
        ---------------------
        
        * Fix  "AttributeError" when submitting a job as a real user.
          `Pull Request 124`_, `Issue 123`_
        
        ---------------------
        0.7.2 (2016-08-31)
        ---------------------
        
        * Fix bug causing loops on in response to preprocessing error conditions.
        
        ---------------------
        0.7.1 (2016-08-29)
        ---------------------
        
        * Do a release to circumvent a tool version logic error in Galaxy (
          released Galaxy versions think 0.7.0 < 0.7.0.dev3).
        
        ---------------------
        0.7.0 (2016-08-26)
        ---------------------
        
        * Update Makefile to allow release pulsar as an application and a library 
          for Galaxy at the same time.
        * Small update to test scripts for TravisCI changes.
        * Improvements for embedded Galaxy runner. (TODO: fill this out)
        * Remove support for Python 2.6. 60bf962_
        * Update docs to describe project goverance and reuse Galaxy's
          Code of Conduct. 7e23d43_, dc47140_
        * Updated cluster slots detection for SLURM from Galaxy. cadfc5a_
        * Various changes to allow usage within Galaxy as a library. ce9d4f9_
        * Various changes to allow embedded Pulsar managers within Galaxy.
          ce9d4f9_, d262323_, 8f7c04a_
        * Introduce a separate working and metadata directory as required for
          Galaxy 16.04 that requires this separation. 6f4328e_
        * Improve logging and comments. 38953f3_, a985107_, ad33cb9_
        * Add Tox target for Python 2.7 unit testing. d7c524e_
        * Add ``Makefile`` command for setup.py develop. fd82d00_
        
        ---------------------
        0.6.1 (2015-12-23)
        ---------------------
        
        * Tweak release process that left 0.6.0 with an incorrect PyPI description page.
        
        ---------------------
        0.6.0 (2015-12-23)
        ---------------------
        
        * Pulsar now depends on the new ``galaxy-lib`` Python package instead of
          manually synchronizing Python files across Pulsar and Galaxy.
        * Numerous build and testing improvements.
        * Fixed a documentation bug in the code (thanks to @erasche). e8814ae_
        * Remove galaxy.eggs stuff from Pulsar client (thanks to @natefoo). 00197f2_
        * Add new logo to README (thanks to @martenson). abbba40_
        * Implement an optional awknowledgement system on top of the message queue
          system (thanks to @natefoo). `Pull Request 82`_ 431088c_
        * Documentation fixes thanks to @remimarenco. `Pull Request 78`_, `Pull Request 80`_
        * Fix project script bug introduced this cycle (thanks to @nsoranzo). 140a069_
        * Fix config.py on Windows (thanks to @ssorgatem). `Pull Request 84`_
        * Add a job manager for XSEDE jobs (thanks to @natefoo). 1017bc5_
        * Fix pip dependency installation (thanks to @afgane) `Pull Request 73`_
        
        ------------------------
        0.5.0 (2015-05-08)
        ------------------------
        
        * Allow cURL downloader to resume transfers during staging in (thanks to
          @natefoo). 0c61bd9_
        * Fix to cURL downloaders status code handling (thanks to @natefoo). 86f95ce_
        * Fix non-wheel installs from PyPI. `Issue 72`_
        * Fix mesos imports for newer versions of mesos (thanks to @kellrott). fe3e919_
        * More, better logging. 2b3942d_, fa2b6dc_
        
        ------------------------
        0.4.0 (2015-04-20)
        ------------------------
        
        * Python 3 support. `Pull Request 62`_
        * Fix bug encountered when running ``pulsar-main`` and ``pulsar-config`` commands as scripts. 9d43ae0_
        * Add ``pulsar-run`` script for issues commands against a Pulsar server (experimental). 3cc7f74_
        
        ------------------------
        0.3.0 (2015-04-12)
        ------------------------
        
        * Changed the name of project to Pulsar, moved to Github.
        * New RESTful web services interface.
        * SCP and Rsync file staging options added by E. Rasche. `Pull 
          Request <https://github.com/galaxyproject/pulsar/pull/34>`__
        * Allow YAML based configuration.
        * Support for more traditional ``pip``/``setup.py``-style
          installs.
        * Dozens of smaller bugfixes and documentation updates.
        
        ---------------------
        0.2.0
        ---------------------
        
        * Last version named the LWR - found on `BitBucket <https://bitbucket.org/jmchilton/lwr>`__.
        * Still supported in Galaxy as of 15.03 the release.
        * Introduced support for submitting to various queueing systems,
          operation as a Mesos framework, Docker support, and
          various other advanced deployment options.
        * Message queue support.
        * Framework for configurable file actions introduced.
        
        ---------------------
        0.1.0
        ---------------------
        
        * Simple support for running jobs managed by the Python LWR
          web process.
        * https://bitbucket.org/jmchilton/lwr/branch/0.1
        
        ---------------------
        0.0.1
        ---------------------
        
        * See the original `announcement <http://dev.list.galaxyproject.org/New-Remote-Job-Runner-td4138951.html>`__
          and `initial commit <https://github.com/galaxyproject/pulsar/commit/163ed48d5a1902ceb84c38f10db8cbe5a0c1039d>`__.
        
        
        .. github_links
        .. _Pull Request 172: https://github.com/galaxyproject/pulsar/pull/172
        .. _Pull Request 170: https://github.com/galaxyproject/pulsar/pull/170
        .. _Pull Request 165: https://github.com/galaxyproject/pulsar/pull/165
        .. _Pull Request 164: https://github.com/galaxyproject/pulsar/pull/164
        .. _Pull Request 160: https://github.com/galaxyproject/pulsar/pull/160
        .. _Pull Request 159: https://github.com/galaxyproject/pulsar/pull/159
        .. _Pull Request 157: https://github.com/galaxyproject/pulsar/pull/157
        .. _Pull Request 156: https://github.com/galaxyproject/pulsar/pull/156
        .. _Pull Request 145: https://github.com/galaxyproject/pulsar/pull/145
        .. _Pull Request 146: https://github.com/galaxyproject/pulsar/pull/146
        .. _Pull Request 148: https://github.com/galaxyproject/pulsar/pull/148
        .. _Pull Request 149: https://github.com/galaxyproject/pulsar/pull/149
        .. _Pull Request 153: https://github.com/galaxyproject/pulsar/pull/153
        .. _Pull Request 143: https://github.com/galaxyproject/pulsar/pull/143
        .. _Pull Request 141: https://github.com/galaxyproject/pulsar/pull/141
        .. _Pull Request 136: https://github.com/galaxyproject/pulsar/pull/136
        .. _Pull Request 137: https://github.com/galaxyproject/pulsar/pull/137
        .. _Pull Request 140: https://github.com/galaxyproject/pulsar/pull/140
        .. _Pull Request 139: https://github.com/galaxyproject/pulsar/pull/139
        .. _Pull Request 138: https://github.com/galaxyproject/pulsar/pull/138
        .. _Pull Request 132: https://github.com/galaxyproject/pulsar/pull/132
        .. _Pull Request 130: https://github.com/galaxyproject/pulsar/pull/130
        .. _11ce744: https://github.com/galaxyproject/pulsar/commit/11ce744
        .. _3573341: https://github.com/galaxyproject/pulsar/commit/3573341
        .. _93ab8a1: https://github.com/galaxyproject/pulsar/commit/93ab8a1
        .. _929bffa: https://github.com/galaxyproject/pulsar/commit/929bffa
        .. _629fdea: https://github.com/galaxyproject/pulsar/commit/629fdea
        .. _Pull Request 124: https://github.com/galaxyproject/pulsar/pull/124
        .. _Issue 123: https://github.com/galaxyproject/pulsar/issues/123
        .. _ad33cb9: https://github.com/galaxyproject/pulsar/commit/ad33cb9
        .. _d7c524e: https://github.com/galaxyproject/pulsar/commit/d7c524e
        .. _fd82d00: https://github.com/galaxyproject/pulsar/commit/fd82d00
        .. _a985107: https://github.com/galaxyproject/pulsar/commit/a985107
        .. _38953f3: https://github.com/galaxyproject/pulsar/commit/38953f3
        .. _6f4328e: https://github.com/galaxyproject/pulsar/commit/6f4328e
        .. _8f7c04a: https://github.com/galaxyproject/pulsar/commit/8f7c04a
        .. _cadfc5a: https://github.com/galaxyproject/pulsar/commit/cadfc5a
        .. _d262323: https://github.com/galaxyproject/pulsar/commit/d262323
        .. _ce0636a: https://github.com/galaxyproject/pulsar/commit/ce0636a
        .. _ce9d4f9: https://github.com/galaxyproject/pulsar/commit/ce9d4f9
        .. _dc47140: https://github.com/galaxyproject/pulsar/commit/dc47140
        .. _7e23d43: https://github.com/galaxyproject/pulsar/commit/7e23d43
        .. _60bf962: https://github.com/galaxyproject/pulsar/commit/60bf962
        .. _Pull Request 73: https://github.com/galaxyproject/pulsar/pull/73
        .. _1017bc5: https://github.com/galaxyproject/pulsar/commit/1017bc5
        .. _Pull Request 84: https://github.com/galaxyproject/pulsar/pull/84
        .. _140a069: https://github.com/galaxyproject/pulsar/commit/140a069
        .. _Pull Request 78: https://github.com/galaxyproject/pulsar/pull/78
        .. _Pull Request 80: https://github.com/galaxyproject/pulsar/pull/80
        .. _Pull Request 82: https://github.com/galaxyproject/pulsar/pull/82
        .. _abbba40: https://github.com/galaxyproject/pulsar/commit/abbba40
        .. _00197f2: https://github.com/galaxyproject/pulsar/commit/00197f2
        .. _431088c: https://github.com/galaxyproject/pulsar/commit/431088c
        .. _e8814ae: https://github.com/galaxyproject/pulsar/commit/e8814ae
        .. _fe3e919: https://github.com/galaxyproject/pulsar/commit/fe3e919
        .. _2b3942d: https://github.com/galaxyproject/pulsar/commit/2b3942d
        .. _fa2b6dc: https://github.com/galaxyproject/pulsar/commit/fa2b6dc
        .. _0c61bd9: https://github.com/galaxyproject/pulsar/commit/0c61bd9
        .. _86f95ce: https://github.com/galaxyproject/pulsar/commit/86f95ce
        .. _Issue 72: https://github.com/galaxyproject/pulsar/issues/72
        .. _3cc7f74: https://github.com/galaxyproject/pulsar/commit/3cc7f74
        .. _9d43ae0: https://github.com/galaxyproject/pulsar/commit/9d43ae0
        .. _Pull Request 62: https://github.com/galaxyproject/pulsar/pull/62
        
Keywords: pulsar
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
