Metadata-Version: 2.1
Name: renku
Version: 0.4.1.dev12
Summary: Python SDK and CLI for the Renku platform.
Home-page: https://github.com/swissdatasciencecenter/renku-python
Author: Swiss Data Science Center
Author-email: contact@datascience.ch
License: Apache License 2.0
Project-URL: Changelog, https://github.com/swissdatasciencecenter/renku-pythonblob/master/CHANGES.rst
Project-URL: Docs, https://renku-python.rtfd.io/
Keywords: Renku CLI
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 1 - Planning
Description-Content-Type: text/x-rst
Requires-Dist: PyYAML (>=3.12)
Requires-Dist: appdirs (>=1.4.3)
Requires-Dist: attrs (>=18.2.0)
Requires-Dist: click (>=6.7)
Requires-Dist: click-completion (>=0.5.0)
Requires-Dist: cwltool (==1.0.20181012180214)
Requires-Dist: environ-config (>=18.2.0)
Requires-Dist: filelock (>=3.0.0)
Requires-Dist: gitpython (>=2.1.8)
Requires-Dist: psutil (>=5.4.7)
Requires-Dist: pyld (>=1.0.3)
Requires-Dist: python-dateutil (>=2.6.1)
Requires-Dist: rdflib-jsonld (>=0.4.0)
Requires-Dist: requests (>=2.20.1)
Requires-Dist: tabulate (>=0.7.7)
Requires-Dist: werkzeug (>=0.12)
Provides-Extra: all
Requires-Dist: pytest-runner (>=2.6.2) ; extra == 'all'
Requires-Dist: setuptools-scm (>=3.1.0) ; extra == 'all'
Requires-Dist: Sphinx (>=1.6.3) ; extra == 'all'
Requires-Dist: renku-sphinx-theme (>=0.1.0) ; extra == 'all'
Requires-Dist: cwlref-runner (>=1.0) ; extra == 'all'
Requires-Dist: sentry-sdk (>=0.7.4) ; extra == 'all'
Requires-Dist: check-manifest (>=0.37) ; extra == 'all'
Requires-Dist: coverage (>=4.0) ; extra == 'all'
Requires-Dist: flake8 (>=3.5) ; extra == 'all'
Requires-Dist: freezegun (>=0.3.9) ; extra == 'all'
Requires-Dist: isort (==4.3.4) ; extra == 'all'
Requires-Dist: pydocstyle (>=3.0.0) ; extra == 'all'
Requires-Dist: pytest-cache (>=1.0) ; extra == 'all'
Requires-Dist: pytest-cov (>=2.5.1) ; extra == 'all'
Requires-Dist: pytest-flake8 (>=1.0.4) ; extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6) ; extra == 'all'
Requires-Dist: pytest-yapf (>=0.1.1) ; extra == 'all'
Requires-Dist: pytest (>=4.0.0) ; extra == 'all'
Requires-Dist: responses (>=0.7.0) ; extra == 'all'
Requires-Dist: yapf (>=0.26.0) ; extra == 'all'
Provides-Extra: docs
Requires-Dist: Sphinx (>=1.6.3) ; extra == 'docs'
Requires-Dist: renku-sphinx-theme (>=0.1.0) ; extra == 'docs'
Provides-Extra: notebook
Provides-Extra: runner
Requires-Dist: cwlref-runner (>=1.0) ; extra == 'runner'
Provides-Extra: sentry
Requires-Dist: sentry-sdk (>=0.7.4) ; extra == 'sentry'
Provides-Extra: tests
Requires-Dist: check-manifest (>=0.37) ; extra == 'tests'
Requires-Dist: coverage (>=4.0) ; extra == 'tests'
Requires-Dist: flake8 (>=3.5) ; extra == 'tests'
Requires-Dist: freezegun (>=0.3.9) ; extra == 'tests'
Requires-Dist: isort (==4.3.4) ; extra == 'tests'
Requires-Dist: pydocstyle (>=3.0.0) ; extra == 'tests'
Requires-Dist: pytest-cache (>=1.0) ; extra == 'tests'
Requires-Dist: pytest-cov (>=2.5.1) ; extra == 'tests'
Requires-Dist: pytest-flake8 (>=1.0.4) ; extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.6) ; extra == 'tests'
Requires-Dist: pytest-yapf (>=0.1.1) ; extra == 'tests'
Requires-Dist: pytest (>=4.0.0) ; extra == 'tests'
Requires-Dist: responses (>=0.7.0) ; extra == 'tests'
Requires-Dist: yapf (>=0.26.0) ; extra == 'tests'

..
    Copyright 2017-2018 - Swiss Data Science Center (SDSC)
    A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
    Eidgenössische Technische Hochschule Zürich (ETHZ).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

==============================
 Renku CLI and SDK for Python
==============================

.. image:: https://img.shields.io/travis/SwissDataScienceCenter/renku-python.svg
   :target: https://travis-ci.org/SwissDataScienceCenter/renku-python

.. image:: https://img.shields.io/coveralls/SwissDataScienceCenter/renku-python.svg
   :target: https://coveralls.io/r/SwissDataScienceCenter/renku-python

.. image:: https://img.shields.io/github/tag/SwissDataScienceCenter/renku-python.svg
   :target: https://github.com/SwissDataScienceCenter/renku-python/releases

.. image:: https://img.shields.io/pypi/dm/renku.svg
   :target: https://pypi.python.org/pypi/renku

.. image:: http://readthedocs.org/projects/renku-python/badge/?version=latest
   :target: http://renku-python.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://img.shields.io/github/license/SwissDataScienceCenter/renku-python.svg
        :target: https://github.com/SwissDataScienceCenter/renku-python/blob/master/LICENSE

A Python library for the `Renku collaborative data science platform
<https://github.com/SwissDataScienceCenter/renku>`_. It allows the user to
create projects, manage datasets, and capture data provenance while performing
analysis tasks.

**NOTE**:
   ``renku-python`` is the python library for Renku that provides an SDK and a
   command-line interface (CLI). It *does not* start the Renku platform itself -
   for that, refer to the Renku docs on `running the platform
   <https://renku.readthedocs.io/en/latest/user/setup.html>`_.

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

The latest release is available on PyPI and can be installed using
``pip``:

::

    $ pip install renku

The latest development versions are available on PyPI or from the Git
repository:

::

    $ pip install --dev renku
    # - OR -
    $ pip install -e git+https://github.com/SwissDataScienceCenter/renku-python.git#egg=renku

Use following installation steps based on your operating system and preferences
if you would like to work with the command line interface and you do not need
the Python library to be importable.

MacOS
-----

The recommended way of installing Renku on MacOS is via `Homebrew <brew.sh>`_.

::

    $ brew tap swissdatasciencecenter/renku
    $ brew install renku

..
  TODO: uncomment one the snap build works.

  Linux
  -----

  There are universal *snap* packages available for Renku. Make sure you
  have the ``snap`` command available or `install snapd
  <https://docs.snapcraft.io/core/install>`_.

  ::

      $ open https://launchpad.net/~swissdatasciencecenter/+snap/renku/
      $ snap install renku

Isolated environments using ``pipx``
------------------------------------

Install and execute Renku in an isolated environment using ``pipx``.
It will guarantee that there are no version conflicts with dependencies
you are using for your work and research.

`Install pipx <https://github.com/pipxproject/pipx#install-pipx>`_
and make sure that the ``$PATH`` is correctly configured.

::

    $ python3 -m pip install --user pipx
    $ pipx ensurepath

Once ``pipx`` is installed use following command to install ``renku``.

::

    $ pipx install renku
    $ which renku
    ~/.local/bin/renku

Prevously we have recommended to use ``pipsi``. You can still use it or
`migrate to **pipx**
<https://github.com/pipxproject/pipx#migrating-to-pipx-from-pipsi>`_.

Docker
------

The containerized version of the CLI can be launched using Docker command.

::

    $ docker run -it -v "$PWD":"$PWD" -w="$PWD" renku/renku-python renku

It makes sure your current directory is mounted to the same place in the container.

Usage
=====

Initialize a renku project:

::

    $ mkdir -p ~/temp/my-renku-project
    $ cd ~/temp/my-renku-project
    $ renku init

Create a dataset and add data to it:

::

    $ renku dataset create my-dataset
    $ renku dataset add my-dataset https://raw.githubusercontent.com/SwissDataScienceCenter/renku-python/master/README.rst

Run an analysis:

::

    $ renku run wc < data/my-dataset/README.rst > wc_readme

Trace the data provenance:

::

    $ renku log wc_readme

These are the basics, but there is much more that Renku allows you to do with
your data analysis workflows. The full documentation will soon be available
at: https://renku-python.readthedocs.io/


..
    Copyright 2017-2019 - Swiss Data Science Center (SDSC)
    A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
    Eidgenössische Technische Hochschule Zürich (ETHZ).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

Changes
=======

``v0.4.0``
----------

*(released 2019-03-05)*

- Adds ``renku mv`` command which updates dataset metadata, ``.gitattributes``
  and symlinks.
- Pulls LFS objects from submodules correctly.
- Adds listing of datasets.
- Adds reduced dot format for ``renku log``.
- Adds ``doctor`` command to check missing files in datasets.
- Moves dataset metadata to ``.renku/datasets`` and adds ``migrate datasets``
  command and uses UUID for metadata path.
- Gets git attrs for files to prevent duplicates in ``.gitattributes``.
- Fixes ``renku show outputs`` for directories.
- Runs Git LFS checkout in a worktrees and lazily pulls necessary LFS files
  before running commands.
- Asks user before overriding an existing file using ``renku init``
  or ``renku runner template``.
- Fixes ``renku init --force`` in an empty dir.
- Renames ``CommitMixin._location`` to ``_project``.
- Addresses issue with commits editing multiple CWL files.
- Exports merge commits for full lineage.
- Exports path and parent directories.
- Adds an automatic check for the latest version.
- Simplifies issue submission from traceback to GitHub or Sentry.
  Requires ``SENTRY_DSN`` variable to be set and `sentry-sdk` package to be
  installed before sending any data.
- Removes outputs before run.
- Allows update of directories.
- Improves readability of the status message.
- Checks ignored path when added to a dataset.
- Adds API method for finding ignored paths.
- Uses branches for ``init --force``.
- Fixes CVE-2017-18342.
- Fixes regex for parsing Git remote URLs.
- Handles ``--isolation`` option using ``git worktree``.
- Renames ``client.git`` to ``client.repo``.
- Supports ``python -m renku``.
- Allows '.' and '-' in repo path.


``v0.3.3``
----------

*(released 2018-12-07)*

- Fixes generated Homebrew formula.
- Renames ``renku pull path`` to ``renku storage pull`` with deprecation
  warning.

``v0.3.2``
----------

*(released 2018-11-29)*

- Fixes display of workflows in ``renku log``.

``v0.3.1``
----------

*(released 2018-11-29)*

- Fixes issues with parsing remote Git URLs.

``v0.3.0``
----------

*(released 2018-11-26)*

- Adds JSON-LD context to objects extracted from the Git repository
  (see ``renku show context --list``).
- Uses PROV-O and WFPROV as provenance vocabularies and generates "stable"
  object identifiers (``@id``) for RDF and JSON-LD output formats.
- Refactors the log output to allow linking files and directories.
- Adds support for aliasing tools and workflows.
- Adds option to install shell completion (``renku --install-completion``).
- Fixes initialization of Git submodules.
- Uses relative submodule paths when appropriate.
- Simplifies external storage configuration.

``v0.2.0``
----------

*(released 2018-09-25)*

- Refactored version using Git and Common Workflow Language.

``v0.1.0``
----------

*(released 2017-09-06)*

- Initial public release as Renga.


