.. image:: https://github.com/datalad/datalad-installer/workflows/Test/badge.svg?branch=master
:target: https://github.com/datalad/datalad-installer/actions?workflow=Test
:alt: GitHub Actions Status
.. image:: https://ci.appveyor.com/api/projects/status/rec96m4r74nrupvn/branch/master?svg=true
:target: https://ci.appveyor.com/project/mih/datalad-installer/branch/master
:alt: Appveyor Status
.. image:: https://codecov.io/gh/datalad/datalad-installer/branch/master/graph/badge.svg
:target: https://codecov.io/gh/datalad/datalad-installer
.. image:: https://img.shields.io/pypi/pyversions/datalad-installer.svg
:target: https://pypi.org/project/datalad-installer/
.. image:: https://img.shields.io/conda/vn/conda-forge/datalad-installer.svg
:target: https://anaconda.org/conda-forge/datalad-installer
:alt: Conda Version
.. image:: https://img.shields.io/github/license/datalad/datalad-installer.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT License
`GitHub <https://github.com/datalad/datalad-installer>`_
| `PyPI <https://pypi.org/project/datalad-installer/>`_
| `Anaconda <https://anaconda.org/conda-forge/datalad-installer>`_
| `Issues <https://github.com/datalad/datalad-installer/issues>`_
| `Changelog <https://github.com/datalad/datalad-installer/blob/master/CHANGELOG.md>`_
``datalad-installer`` is a script for installing Datalad_, git-annex_, and
related components all in a single invocation. It requires no third-party
Python libraries, though it does make heavy use of external packaging commands.
.. _Datalad: https://www.datalad.org
.. _git-annex: https://git-annex.branchable.com
Installation
============
``datalad-installer`` requires Python 3.7 or higher. Just use `pip
<https://pip.pypa.io>`_ for Python 3 (You have pip, right?) to install it::
python3 -m pip install datalad-installer
``datalad-installer`` is also available for conda! To install, run::
conda install -c conda-forge datalad-installer
Alternatively, download the latest version directly from
<https://raw.githubusercontent.com/datalad/datalad-installer/master/src/datalad_installer.py>.
Usage
=====
::
datalad-installer [<global options>] <component>[=<version>] [<options>] <component>[=<version>] [<options>] ...
``datalad-installer`` provisions one or more *components* listed on the command
line. Each component is either a software package (e.g., Datalad or git-annex)
or an environment in which software packages can be installed. If no
components are specified on the command line, the script defaults to installing
the ``datalad`` component.
Global Options
--------------
-E FILE, --env-write-file FILE Append any ``PATH`` modifications or other
shell commands needed to use the new components
to the given file. This option can be
specified multiple times. If this option is
not given, the data is written to a temporary
file whose location is logged at the beginning
of the program.
-l LEVEL, --log-level LEVEL Set the log level to the given value. Possible
values are "``CRITICAL``", "``ERROR``",
"``WARNING``", "``INFO``", "``DEBUG``" (all
case-insensitive) and their Python integer
equivalents. [default value: INFO]
--sudo <ask|error|ok> What to do when the script needs to run a
command with ``sudo`` or privilege escalation:
ask for confirmation (default), error, or run
without confirmation. This is always "``ok``"
on Windows, where the system always asks for
confirmation.
-V, --version Display the script version and exit
-h, --help Display usage information and exit
Components
----------
``venv``
~~~~~~~~
Creates a Python virtual environment using ``python -m venv``. Subsequent
``datalad`` components on the command line will be installed into this virtual
environment by default if not overridden by an intervening component.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
``python -m venv``
--path PATH Create the virtual environment at ``PATH``. If
not specified, the environment will be created
in a directory in ``$TMPDIR``.
``miniconda``
~~~~~~~~~~~~~
Installs the latest version of Miniconda. Subsequent ``conda-env`` components
on the command line will use this installation, and subsequent ``datalad``,
``git-annex``, ``rclone``, and ``git-annex-remote-rclone`` components will be
installed using this conda by default if not overridden by an intervening
component.
A specific version to install can be specified by suffixing "``miniconda``"
with "``=``" and the version on the command line, where the version is the
version component of a file at ``$ANACONDA_URL`` or
<https://repo.anaconda.com/miniconda/>, e.g., ``py37_23.1.0-1``. Run
``datalad-installer miniconda --help-versions`` to see a list of available
versions for your platform.
If not specified, the version defaults to ``latest``.
The Miniconda installation script is downloaded from
``$ANACONDA_URL/Miniconda3-$VERSION-$OS-$ARCH.{sh,exe}``, where
``$ANACONDA_URL`` is taken from the environment, defaulting to
``https://repo.anaconda.com/miniconda``.
Options
'''''''
--batch Run the Miniconda installation script in batch
(noninteractive) mode. This is always done
when installing on Windows.
In addition, if a spec is given (see below),
this option causes ``--yes`` to be passed to
``conda install``.
-c CHANNEL, --channel CHANNEL Specify additional Conda channels to use when
installing the packages listed in the spec (see
below). This option can be specified multiple
times.
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the Miniconda installation script.
--path PATH Install Miniconda at ``PATH``. If not
specified, it will be installed in a directory
in ``$TMPDIR``.
--python-match <major|minor|micro>
Include ``python=V`` in the ``--spec``, where
``V`` is the Python version used to run
``datalad-installer`` to the given version
level (e.g., under Python 3.9.13,
``--python-match major`` will install
``python=3``, ``minor`` will install
``python=3.9``, and ``micro`` will install
``python=3.9.13``)
--spec SPEC Space-separated specifiers for packages to
install in the Conda base environment after
provisioning.
--help-versions Show a list of available Miniconda versions for
this platform and exit
``conda-env``
~~~~~~~~~~~~~
Creates a Conda environment. If there is no preceding ``miniconda`` component
on the command line, Conda must already be installed on the system, and this
installation will be used to create the environment.
Subsequent ``datalad``, ``git-annex``, ``rclone``, and
``git-annex-remote-rclone`` components will be installed into this environment
by default if not overridden by an intervening component.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the ``conda create`` command.
-n NAME, --name NAME The name for the new environment. If not
specified, a random name will be generated.
--spec SPEC Space-separated specifiers for packages to
install in the new environment.
``neurodebian``
~~~~~~~~~~~~~~~
Installs & configures `NeuroDebian <https://neuro.debian.net>`_.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the ``nd-configurerepo`` command.
``git-annex``
~~~~~~~~~~~~~
Installs git-annex_. The component takes an ``-m``, ``--method`` option
specifying the installation method to use; the supported methods are:
- ``apt``
- ``autobuild``
- ``brew``
- ``conda`` (only supported on Linux)
- ``datalad/git-annex``
- ``datalad/git-annex:release``
- ``datalad/git-annex:tested``
- ``datalad/packages``
- ``deb-url``
- ``dmg``
- ``neurodebian``
- ``snapshot``
If no method is specified, or if the method is set to "``auto``", then the most
recent component on the command line that provides a compatible installation
method will be used. If there is no such component, the first supported
installation method from the following list will be used:
- ``conda``
- ``apt``
- ``neurodebian``
- ``brew``
- ``autobuild``
- ``datalad/packages``
A specific version to install can be specified for those methods that support
it by suffixing "``git-annex``" with "``=``" and the version number on the
command line.
The ``git-annex`` component also accepts all options for the supported
installation methods; options not belonging to whichever method ends up used
will be ignored.
``datalad``
~~~~~~~~~~~
Installs Datalad_. The component takes an ``-m``, ``--method`` option
specifying the installation method to use; the supported methods are:
- ``apt``
- ``brew``
- ``conda``
- ``deb-url``
- ``pip``
If no method is specified, or if the method is set to "``auto``", then the most
recent component on the command line that provides a compatible installation
method will be used. If there is no such component, the first supported
installation method from the following list will be used:
- ``conda``
- ``apt``
- ``brew``
A specific version to install can be specified for those methods that support
it by suffixing "``datalad``" with "``=``" and the version number on the
command line.
The ``datalad`` component also accepts all options for the supported
installation methods; options not belonging to whichever method ends up used
will be ignored.
``rclone``
~~~~~~~~~~~
Installs rclone_. The component takes an ``-m``, ``--method`` option
specifying the installation method to use; the supported methods are:
.. _rclone: https://rclone.org
- ``apt``
- ``brew``
- ``conda``
- ``deb-url``
- ``downloads.rclone.org``
If no method is specified, or if the method is set to "``auto``", then the most
recent component on the command line that provides a compatible installation
method will be used. If there is no such component, the first supported
installation method from the following list will be used:
- ``conda``
- ``apt``
- ``brew``
- ``downloads.rclone.org``
A specific version to install can be specified for those methods that support
it by suffixing "``rclone``" with "``=``" and the version number on the
command line.
The ``rclone`` component also accepts all options for the supported
installation methods; options not belonging to whichever method ends up used
will be ignored.
``git-annex-remote-rclone``
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Installs git-annex-remote-rclone_. The component takes an ``-m``, ``--method``
option specifying the installation method to use; the supported methods are:
.. _git-annex-remote-rclone:
https://github.com/DanielDent/git-annex-remote-rclone
- ``apt``
- ``brew``
- ``conda``
- ``deb-url``
- ``DanielDent/git-annex-remote-rclone``
If no method is specified, or if the method is set to "``auto``", then the most
recent component on the command line that provides a compatible installation
method will be used. If there is no such component, the first supported
installation method from the following list will be used:
- ``conda``
- ``apt``
- ``brew``
- ``DanielDent/git-annex-remote-rclone``
A specific version to install can be specified for those methods that support
it by suffixing "``git-annex-remote-rclone``" with "``=``" and the version
number on the command line.
The ``git-annex-remote-rclone`` component also accepts all options for the
supported installation methods; options not belonging to whichever method ends
up used will be ignored.
Installation Methods
--------------------
``apt``
~~~~~~~
Installs with ``sudo apt-get install``. Supports installing specific versions.
Options
'''''''
--build-dep Run ``sudo apt-get build-dep`` instead of
``sudo apt-get install``.
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
``autobuild``
~~~~~~~~~~~~~
Downloads & installs the latest official build of ``git-annex`` from
kitenet.net. Does not support installing specific versions.
This installation method is only supported on Linux and macOS.
``brew``
~~~~~~~~
Installs with ``brew`` (`Homebrew <https://brew.sh>`_). Does not support
installing specific versions.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
``conda``
~~~~~~~~~
Installs with ``conda install``. Supports installing specific versions.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
``DanielDent/git-annex-remote-rclone``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``git-annex-remote-rclone`` from a release of its GitHub
project.
This installation method is only supported on Linux and macOS.
Options
'''''''
--bin-dir DIR Directory in which to install the ``rclone``
executable. Defaults to ``/usr/local/bin``.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``.
``datalad/git-annex``
~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``git-annex`` from the latest build of `datalad/git-annex
<https://github.com/datalad/git-annex>`_ that produced artifacts for the
running OS. Does not support installing specific versions.
This installation method requires a GitHub OAuth token with appropriate
permissions. It must be specified either via the ``GITHUB_TOKEN`` environment
variable or as the value of the ``hub.oauthtoken`` Git config option.
Options
'''''''
--install-dir DIR Directory in which to unpack the ``*.deb``
package instead of installing it system-wide.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``. (Linux only)
``datalad/git-annex:release``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``git-annex`` for the running OS from the latest release
(or the specified version) of `datalad/git-annex
<https://github.com/datalad/git-annex>`_. If no explicit version is specified
and the latest release lacks an asset for the running OS, the most recent
release with a matching asset is used.
Options
'''''''
--install-dir DIR Directory in which to unpack the ``*.deb``
package instead of installing it system-wide.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``. (Linux only)
``datalad/git-annex:tested``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``git-annex`` from the latest successful build of
`datalad/git-annex <https://github.com/datalad/git-annex>`_ for the running OS.
Does not support installing specific versions.
This installation method requires a GitHub OAuth token with appropriate
permissions. It must be specified either via the ``GITHUB_TOKEN`` environment
variable or as the value of the ``hub.oauthtoken`` Git config option.
Options
'''''''
--install-dir DIR Directory in which to unpack the ``*.deb``
package instead of installing it system-wide.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``. (Linux only)
``datalad/packages``
~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``git-annex`` from
<https://datasets.datalad.org/?dir=/datalad/packages> for the running OS.
Supports installing specific versions (though note that the version strings for
this method tend to include Git commit information, e.g.,
"``8.20210127+git111-gbe5a0e4b8``").
Options
'''''''
--install-dir DIR Directory in which to unpack the ``*.deb``
package instead of installing it system-wide.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``. (Linux only)
``deb-url``
~~~~~~~~~~~
Download & install a given ``*.deb`` package. Does not support installing
specific versions.
Options
'''''''
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
--install-dir DIR Directory in which to unpack the ``*.deb``
package instead of installing it system-wide.
If this contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR``. If this contains the string
``{version}``, it will be replaced with the
package's version. (``git-annex`` only)
--url URL Specify the URL of the ``*.deb`` package. This
option is required for this installation
method.
``dmg``
~~~~~~~
Installs ``git-annex`` to the ``/Applications`` directory from a properly-built
``*.dmg`` image. Does not support installing specific versions.
This installation method is only supported on macOS.
Options
'''''''
--path PATH Specify the path to the ``*.dmg`` image. This
option is required for this installation
method.
``downloads.rclone.org``
~~~~~~~~~~~~~~~~~~~~~~~~
Downloads & installs ``rclone`` from <https://downloads.rclone.org>.
Options
'''''''
--bin-dir DIR Directory in which to install the ``rclone``
executable. This option is required on
Windows. On Linux & macOS, the directory
defaults to ``/usr/local/bin``. If the path
contains the string ``{tmpdir}``, it will be
replaced with the path to a directory in
``$TMPDIR``.
--man-dir DIR Directory under which to install the ``rclone``
manpage; specifically, the file ``rclone.1``
will be placed in the ``man1/`` subdirectory of
the given directory. If this option is not
specified, the manpage is not installed. If
the path contains the string ``{tmpdir}``, it
will be replaced with the path to a directory
in ``$TMPDIR`` (the same one as used for
``--bin-dir``, if applicable).
``neurodebian``
~~~~~~~~~~~~~~~
Installs from NeuroDebian repositories with ``sudo apt-get install``. Supports
installing specific versions.
Options
'''''''
--build-dep Run ``sudo apt-get build-dep`` instead of
``sudo apt-get install``.
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
``pip``
~~~~~~~
Installs with ``python -m pip``. Supports installing specific versions.
If a ``venv`` component is previously given on the command line, the
installation will be performed in that virtual environment; otherwise, it will
be performed using the same Python used to run ``datalad-installer``.
Options
'''''''
--devel Install the given component from its GitHub
repository instead of from PyPI.
-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to
the installation command.
-E EXTRAS, --extras EXTRAS Specify (comma-separated) package extras to
install.
``snapshot``
~~~~~~~~~~~~
Downloads & installs the latest official snapshot build of ``git-annex`` from
kitenet.net. Does not support installing specific versions.
This installation method is only supported on Linux and macOS.
Raw data
{
"_id": null,
"home_page": "https://github.com/datalad/datalad-installer",
"name": "datalad-installer",
"maintainer": "John Thorvald Wodder II",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "datalad-installer@varonathe.org",
"keywords": "apt, conda, datalad, git-annex, installer, miniconda, neurodebian",
"author": "The DataLad Team and Contributors",
"author_email": "team@datalad.org",
"download_url": "https://files.pythonhosted.org/packages/34/59/73cbd332ad8132d52950344239d321dc4140f8bcda3feea07add3733db06/datalad_installer-1.1.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/datalad/datalad-installer/workflows/Test/badge.svg?branch=master\n :target: https://github.com/datalad/datalad-installer/actions?workflow=Test\n :alt: GitHub Actions Status\n\n.. image:: https://ci.appveyor.com/api/projects/status/rec96m4r74nrupvn/branch/master?svg=true\n :target: https://ci.appveyor.com/project/mih/datalad-installer/branch/master\n :alt: Appveyor Status\n\n.. image:: https://codecov.io/gh/datalad/datalad-installer/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/datalad/datalad-installer\n\n.. image:: https://img.shields.io/pypi/pyversions/datalad-installer.svg\n :target: https://pypi.org/project/datalad-installer/\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/datalad-installer.svg\n :target: https://anaconda.org/conda-forge/datalad-installer\n :alt: Conda Version\n\n.. image:: https://img.shields.io/github/license/datalad/datalad-installer.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT License\n\n`GitHub <https://github.com/datalad/datalad-installer>`_\n| `PyPI <https://pypi.org/project/datalad-installer/>`_\n| `Anaconda <https://anaconda.org/conda-forge/datalad-installer>`_\n| `Issues <https://github.com/datalad/datalad-installer/issues>`_\n| `Changelog <https://github.com/datalad/datalad-installer/blob/master/CHANGELOG.md>`_\n\n``datalad-installer`` is a script for installing Datalad_, git-annex_, and\nrelated components all in a single invocation. It requires no third-party\nPython libraries, though it does make heavy use of external packaging commands.\n\n.. _Datalad: https://www.datalad.org\n.. _git-annex: https://git-annex.branchable.com\n\nInstallation\n============\n``datalad-installer`` requires Python 3.7 or higher. Just use `pip\n<https://pip.pypa.io>`_ for Python 3 (You have pip, right?) to install it::\n\n python3 -m pip install datalad-installer\n\n``datalad-installer`` is also available for conda! To install, run::\n\n conda install -c conda-forge datalad-installer\n\nAlternatively, download the latest version directly from\n<https://raw.githubusercontent.com/datalad/datalad-installer/master/src/datalad_installer.py>.\n\n\nUsage\n=====\n\n::\n\n datalad-installer [<global options>] <component>[=<version>] [<options>] <component>[=<version>] [<options>] ...\n\n``datalad-installer`` provisions one or more *components* listed on the command\nline. Each component is either a software package (e.g., Datalad or git-annex)\nor an environment in which software packages can be installed. If no\ncomponents are specified on the command line, the script defaults to installing\nthe ``datalad`` component.\n\n\nGlobal Options\n--------------\n\n-E FILE, --env-write-file FILE Append any ``PATH`` modifications or other\n shell commands needed to use the new components\n to the given file. This option can be\n specified multiple times. If this option is\n not given, the data is written to a temporary\n file whose location is logged at the beginning\n of the program.\n\n-l LEVEL, --log-level LEVEL Set the log level to the given value. Possible\n values are \"``CRITICAL``\", \"``ERROR``\",\n \"``WARNING``\", \"``INFO``\", \"``DEBUG``\" (all\n case-insensitive) and their Python integer\n equivalents. [default value: INFO]\n\n--sudo <ask|error|ok> What to do when the script needs to run a\n command with ``sudo`` or privilege escalation:\n ask for confirmation (default), error, or run\n without confirmation. This is always \"``ok``\"\n on Windows, where the system always asks for\n confirmation.\n\n-V, --version Display the script version and exit\n\n-h, --help Display usage information and exit\n\n\nComponents\n----------\n\n``venv``\n~~~~~~~~\n\nCreates a Python virtual environment using ``python -m venv``. Subsequent\n``datalad`` components on the command line will be installed into this virtual\nenvironment by default if not overridden by an intervening component.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n ``python -m venv``\n\n--path PATH Create the virtual environment at ``PATH``. If\n not specified, the environment will be created\n in a directory in ``$TMPDIR``.\n\n\n``miniconda``\n~~~~~~~~~~~~~\n\nInstalls the latest version of Miniconda. Subsequent ``conda-env`` components\non the command line will use this installation, and subsequent ``datalad``,\n``git-annex``, ``rclone``, and ``git-annex-remote-rclone`` components will be\ninstalled using this conda by default if not overridden by an intervening\ncomponent.\n\nA specific version to install can be specified by suffixing \"``miniconda``\"\nwith \"``=``\" and the version on the command line, where the version is the\nversion component of a file at ``$ANACONDA_URL`` or\n<https://repo.anaconda.com/miniconda/>, e.g., ``py37_23.1.0-1``. Run\n``datalad-installer miniconda --help-versions`` to see a list of available\nversions for your platform.\n\nIf not specified, the version defaults to ``latest``.\n\nThe Miniconda installation script is downloaded from\n``$ANACONDA_URL/Miniconda3-$VERSION-$OS-$ARCH.{sh,exe}``, where\n``$ANACONDA_URL`` is taken from the environment, defaulting to\n``https://repo.anaconda.com/miniconda``.\n\nOptions\n'''''''\n\n--batch Run the Miniconda installation script in batch\n (noninteractive) mode. This is always done\n when installing on Windows.\n\n In addition, if a spec is given (see below),\n this option causes ``--yes`` to be passed to\n ``conda install``.\n\n-c CHANNEL, --channel CHANNEL Specify additional Conda channels to use when\n installing the packages listed in the spec (see\n below). This option can be specified multiple\n times.\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the Miniconda installation script.\n\n--path PATH Install Miniconda at ``PATH``. If not\n specified, it will be installed in a directory\n in ``$TMPDIR``.\n\n--python-match <major|minor|micro>\n Include ``python=V`` in the ``--spec``, where\n ``V`` is the Python version used to run\n ``datalad-installer`` to the given version\n level (e.g., under Python 3.9.13,\n ``--python-match major`` will install\n ``python=3``, ``minor`` will install\n ``python=3.9``, and ``micro`` will install\n ``python=3.9.13``)\n\n--spec SPEC Space-separated specifiers for packages to\n install in the Conda base environment after\n provisioning.\n\n--help-versions Show a list of available Miniconda versions for\n this platform and exit\n\n\n``conda-env``\n~~~~~~~~~~~~~\n\nCreates a Conda environment. If there is no preceding ``miniconda`` component\non the command line, Conda must already be installed on the system, and this\ninstallation will be used to create the environment.\n\nSubsequent ``datalad``, ``git-annex``, ``rclone``, and\n``git-annex-remote-rclone`` components will be installed into this environment\nby default if not overridden by an intervening component.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the ``conda create`` command.\n\n-n NAME, --name NAME The name for the new environment. If not\n specified, a random name will be generated.\n\n--spec SPEC Space-separated specifiers for packages to\n install in the new environment.\n\n\n``neurodebian``\n~~~~~~~~~~~~~~~\n\nInstalls & configures `NeuroDebian <https://neuro.debian.net>`_.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the ``nd-configurerepo`` command.\n\n\n``git-annex``\n~~~~~~~~~~~~~\n\nInstalls git-annex_. The component takes an ``-m``, ``--method`` option\nspecifying the installation method to use; the supported methods are:\n\n- ``apt``\n- ``autobuild``\n- ``brew``\n- ``conda`` (only supported on Linux)\n- ``datalad/git-annex``\n- ``datalad/git-annex:release``\n- ``datalad/git-annex:tested``\n- ``datalad/packages``\n- ``deb-url``\n- ``dmg``\n- ``neurodebian``\n- ``snapshot``\n\nIf no method is specified, or if the method is set to \"``auto``\", then the most\nrecent component on the command line that provides a compatible installation\nmethod will be used. If there is no such component, the first supported\ninstallation method from the following list will be used:\n\n- ``conda``\n- ``apt``\n- ``neurodebian``\n- ``brew``\n- ``autobuild``\n- ``datalad/packages``\n\nA specific version to install can be specified for those methods that support\nit by suffixing \"``git-annex``\" with \"``=``\" and the version number on the\ncommand line.\n\nThe ``git-annex`` component also accepts all options for the supported\ninstallation methods; options not belonging to whichever method ends up used\nwill be ignored.\n\n\n``datalad``\n~~~~~~~~~~~\n\nInstalls Datalad_. The component takes an ``-m``, ``--method`` option\nspecifying the installation method to use; the supported methods are:\n\n- ``apt``\n- ``brew``\n- ``conda``\n- ``deb-url``\n- ``pip``\n\nIf no method is specified, or if the method is set to \"``auto``\", then the most\nrecent component on the command line that provides a compatible installation\nmethod will be used. If there is no such component, the first supported\ninstallation method from the following list will be used:\n\n- ``conda``\n- ``apt``\n- ``brew``\n\nA specific version to install can be specified for those methods that support\nit by suffixing \"``datalad``\" with \"``=``\" and the version number on the\ncommand line.\n\nThe ``datalad`` component also accepts all options for the supported\ninstallation methods; options not belonging to whichever method ends up used\nwill be ignored.\n\n\n``rclone``\n~~~~~~~~~~~\n\nInstalls rclone_. The component takes an ``-m``, ``--method`` option\nspecifying the installation method to use; the supported methods are:\n\n.. _rclone: https://rclone.org\n\n- ``apt``\n- ``brew``\n- ``conda``\n- ``deb-url``\n- ``downloads.rclone.org``\n\nIf no method is specified, or if the method is set to \"``auto``\", then the most\nrecent component on the command line that provides a compatible installation\nmethod will be used. If there is no such component, the first supported\ninstallation method from the following list will be used:\n\n- ``conda``\n- ``apt``\n- ``brew``\n- ``downloads.rclone.org``\n\nA specific version to install can be specified for those methods that support\nit by suffixing \"``rclone``\" with \"``=``\" and the version number on the\ncommand line.\n\nThe ``rclone`` component also accepts all options for the supported\ninstallation methods; options not belonging to whichever method ends up used\nwill be ignored.\n\n\n``git-annex-remote-rclone``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstalls git-annex-remote-rclone_. The component takes an ``-m``, ``--method``\noption specifying the installation method to use; the supported methods are:\n\n.. _git-annex-remote-rclone:\n https://github.com/DanielDent/git-annex-remote-rclone\n\n- ``apt``\n- ``brew``\n- ``conda``\n- ``deb-url``\n- ``DanielDent/git-annex-remote-rclone``\n\nIf no method is specified, or if the method is set to \"``auto``\", then the most\nrecent component on the command line that provides a compatible installation\nmethod will be used. If there is no such component, the first supported\ninstallation method from the following list will be used:\n\n- ``conda``\n- ``apt``\n- ``brew``\n- ``DanielDent/git-annex-remote-rclone``\n\nA specific version to install can be specified for those methods that support\nit by suffixing \"``git-annex-remote-rclone``\" with \"``=``\" and the version\nnumber on the command line.\n\nThe ``git-annex-remote-rclone`` component also accepts all options for the\nsupported installation methods; options not belonging to whichever method ends\nup used will be ignored.\n\n\nInstallation Methods\n--------------------\n\n``apt``\n~~~~~~~\n\nInstalls with ``sudo apt-get install``. Supports installing specific versions.\n\nOptions\n'''''''\n\n--build-dep Run ``sudo apt-get build-dep`` instead of\n ``sudo apt-get install``.\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n\n``autobuild``\n~~~~~~~~~~~~~\n\nDownloads & installs the latest official build of ``git-annex`` from\nkitenet.net. Does not support installing specific versions.\n\nThis installation method is only supported on Linux and macOS.\n\n\n``brew``\n~~~~~~~~\n\nInstalls with ``brew`` (`Homebrew <https://brew.sh>`_). Does not support\ninstalling specific versions.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n\n``conda``\n~~~~~~~~~\n\nInstalls with ``conda install``. Supports installing specific versions.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n``DanielDent/git-annex-remote-rclone``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``git-annex-remote-rclone`` from a release of its GitHub\nproject.\n\nThis installation method is only supported on Linux and macOS.\n\nOptions\n'''''''\n\n--bin-dir DIR Directory in which to install the ``rclone``\n executable. Defaults to ``/usr/local/bin``.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``.\n\n``datalad/git-annex``\n~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``git-annex`` from the latest build of `datalad/git-annex\n<https://github.com/datalad/git-annex>`_ that produced artifacts for the\nrunning OS. Does not support installing specific versions.\n\nThis installation method requires a GitHub OAuth token with appropriate\npermissions. It must be specified either via the ``GITHUB_TOKEN`` environment\nvariable or as the value of the ``hub.oauthtoken`` Git config option.\n\nOptions\n'''''''\n\n--install-dir DIR Directory in which to unpack the ``*.deb``\n package instead of installing it system-wide.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``. (Linux only)\n\n\n``datalad/git-annex:release``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``git-annex`` for the running OS from the latest release\n(or the specified version) of `datalad/git-annex\n<https://github.com/datalad/git-annex>`_. If no explicit version is specified\nand the latest release lacks an asset for the running OS, the most recent\nrelease with a matching asset is used.\n\nOptions\n'''''''\n\n--install-dir DIR Directory in which to unpack the ``*.deb``\n package instead of installing it system-wide.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``. (Linux only)\n\n\n``datalad/git-annex:tested``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``git-annex`` from the latest successful build of\n`datalad/git-annex <https://github.com/datalad/git-annex>`_ for the running OS.\nDoes not support installing specific versions.\n\nThis installation method requires a GitHub OAuth token with appropriate\npermissions. It must be specified either via the ``GITHUB_TOKEN`` environment\nvariable or as the value of the ``hub.oauthtoken`` Git config option.\n\nOptions\n'''''''\n\n--install-dir DIR Directory in which to unpack the ``*.deb``\n package instead of installing it system-wide.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``. (Linux only)\n\n\n``datalad/packages``\n~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``git-annex`` from\n<https://datasets.datalad.org/?dir=/datalad/packages> for the running OS.\nSupports installing specific versions (though note that the version strings for\nthis method tend to include Git commit information, e.g.,\n\"``8.20210127+git111-gbe5a0e4b8``\").\n\nOptions\n'''''''\n\n--install-dir DIR Directory in which to unpack the ``*.deb``\n package instead of installing it system-wide.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``. (Linux only)\n\n\n``deb-url``\n~~~~~~~~~~~\n\nDownload & install a given ``*.deb`` package. Does not support installing\nspecific versions.\n\nOptions\n'''''''\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n--install-dir DIR Directory in which to unpack the ``*.deb``\n package instead of installing it system-wide.\n If this contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR``. If this contains the string\n ``{version}``, it will be replaced with the\n package's version. (``git-annex`` only)\n\n--url URL Specify the URL of the ``*.deb`` package. This\n option is required for this installation\n method.\n\n``dmg``\n~~~~~~~\n\nInstalls ``git-annex`` to the ``/Applications`` directory from a properly-built\n``*.dmg`` image. Does not support installing specific versions.\n\nThis installation method is only supported on macOS.\n\nOptions\n'''''''\n\n--path PATH Specify the path to the ``*.dmg`` image. This\n option is required for this installation\n method.\n\n``downloads.rclone.org``\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownloads & installs ``rclone`` from <https://downloads.rclone.org>.\n\nOptions\n'''''''\n\n--bin-dir DIR Directory in which to install the ``rclone``\n executable. This option is required on\n Windows. On Linux & macOS, the directory\n defaults to ``/usr/local/bin``. If the path\n contains the string ``{tmpdir}``, it will be\n replaced with the path to a directory in\n ``$TMPDIR``.\n\n--man-dir DIR Directory under which to install the ``rclone``\n manpage; specifically, the file ``rclone.1``\n will be placed in the ``man1/`` subdirectory of\n the given directory. If this option is not\n specified, the manpage is not installed. If\n the path contains the string ``{tmpdir}``, it\n will be replaced with the path to a directory\n in ``$TMPDIR`` (the same one as used for\n ``--bin-dir``, if applicable).\n\n``neurodebian``\n~~~~~~~~~~~~~~~\n\nInstalls from NeuroDebian repositories with ``sudo apt-get install``. Supports\ninstalling specific versions.\n\nOptions\n'''''''\n\n--build-dep Run ``sudo apt-get build-dep`` instead of\n ``sudo apt-get install``.\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n\n``pip``\n~~~~~~~\n\nInstalls with ``python -m pip``. Supports installing specific versions.\n\nIf a ``venv`` component is previously given on the command line, the\ninstallation will be performed in that virtual environment; otherwise, it will\nbe performed using the same Python used to run ``datalad-installer``.\n\nOptions\n'''''''\n\n--devel Install the given component from its GitHub\n repository instead of from PyPI.\n\n-e ARGS, --extra-args ARGS Specify extra command-line arguments to pass to\n the installation command.\n\n-E EXTRAS, --extras EXTRAS Specify (comma-separated) package extras to\n install.\n\n\n``snapshot``\n~~~~~~~~~~~~\n\nDownloads & installs the latest official snapshot build of ``git-annex`` from\nkitenet.net. Does not support installing specific versions.\n\nThis installation method is only supported on Linux and macOS.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Installation script for Datalad and related components",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/datalad/datalad-installer/issues",
"Homepage": "https://github.com/datalad/datalad-installer",
"Source Code": "https://github.com/datalad/datalad-installer"
},
"split_keywords": [
"apt",
" conda",
" datalad",
" git-annex",
" installer",
" miniconda",
" neurodebian"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "301d1c61f487a4eb14a8137f6a0806fc472c7760c323359385b76ffb87411408",
"md5": "b251f266b199fbd3781790697fad776b",
"sha256": "a7e3a8bbc5595475d37a5a4d03ed522373a03effbeae64ebc135a2c66de50a5d"
},
"downloads": -1,
"filename": "datalad_installer-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b251f266b199fbd3781790697fad776b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 32060,
"upload_time": "2024-11-07T20:13:34",
"upload_time_iso_8601": "2024-11-07T20:13:34.789530Z",
"url": "https://files.pythonhosted.org/packages/30/1d/1c61f487a4eb14a8137f6a0806fc472c7760c323359385b76ffb87411408/datalad_installer-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "345973cbd332ad8132d52950344239d321dc4140f8bcda3feea07add3733db06",
"md5": "7a83755cb1d5226c15964f85effc8136",
"sha256": "5d16dfce4a44b802808eafeccd22ab9824013f21cf7e2a073a40367cc7921e6f"
},
"downloads": -1,
"filename": "datalad_installer-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7a83755cb1d5226c15964f85effc8136",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 52572,
"upload_time": "2024-11-07T20:13:36",
"upload_time_iso_8601": "2024-11-07T20:13:36.394980Z",
"url": "https://files.pythonhosted.org/packages/34/59/73cbd332ad8132d52950344239d321dc4140f8bcda3feea07add3733db06/datalad_installer-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 20:13:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "datalad",
"github_project": "datalad-installer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"tox": true,
"lcname": "datalad-installer"
}
JSON
