# DataLad NEXT extension
[](#contributors)
[](https://ci.appveyor.com/project/mih/datalad-next/branch/main)
[](https://codecov.io/gh/datalad/datalad-next)
[](https://github.com/datalad/datalad-next/actions?query=workflow%3Adocs)
[](http://docs.datalad.org/projects/next/en/latest/?badge=latest)
[](https://opensource.org/licenses/MIT)
[](https://GitHub.com/datalad/datalad-next/releases/)
[](https://pypi.python.org/pypi/datalad-next/)
[](https://doi.org/10.5281/zenodo.6833099)
This DataLad extension can be thought of as a staging area for additional
functionality, or for improved performance and user experience. Unlike other
topical or more experimental extensions, the focus here is on functionality
with broad applicability. This extension is a suitable dependency for other
software packages that intend to build on this improved set of functionality.
## Installation
```
# create and enter a new virtual environment (optional)
$ virtualenv --python=python3 ~/env/dl-next
$ . ~/env/dl-next/bin/activate
# install from PyPi
$ python -m pip install datalad-next
```
## How to use
Additional commands provided by this extension are immediately available
after installation. However, in order to fully benefit from all improvements,
the extension has to be enabled for auto-loading by executing:
git config --global --add datalad.extensions.load next
Doing so will enable the extension to also alter the behavior the core DataLad
package and its commands.
## Summary of functionality provided by this extension
- A replacement sub-system for credential handling that is able to handle arbitrary
properties for annotating a secret, and facilitates determining suitable
credentials while minimizing avoidable user interaction, without compromising
configurability. A convenience method is provided that implements a standard
workflow for obtaining a credential.
- A user-facing `credentials` command to set, remove, and query credentials.
- The `create-sibling-...` commands for the platforms GitHub, GIN, GOGS, Gitea
are equipped with improved credential handling that, for example, only stores
entered credentials after they were confirmed to work, or auto-selects the
most recently used, matching credentials, when none are specified.
- A `create-sibling-webdav` command for hosting datasets on a WebDAV server via
a sibling tandem for Git history and file storage. Datasets hosted on WebDAV
in this fashion are cloneable with `datalad-clone`. A full annex setup
for storing complete datasets with historical file content version, and an
additional mode for depositing single-version dataset snapshot are supported.
The latter enables convenient collaboration with audiences that are not using
DataLad, because all files are browsable via a WebDAV server's point-and-click
user interface.
- Enhance `datalad-push` to automatically export files to git-annex special
remotes configured with `exporttree=yes`.
- Speed-up `datalad-push` when processing non-git special remotes. This particularly
benefits less efficient hosting scenarios like WebDAV.
- Enhance `datalad-siblings enable` (`AnnexRepo.enable_remote()`) to automatically
deploy credentials for git-annex special remotes that require them.
- `git-remote-datalad-annex` is a Git remote helper to push/fetch to any
location accessible by any git-annex special remote.
- `git-annex-backend-XDLRA` (originally available from the `mihextras` extension)
is a custom external git-annex backend used by `git-remote-datalad-annex`. A base
class to facilitate development of external backends in Python is also provided.
- Enhance `datalad-configuration` to support getting configuration from "global"
scope without a dataset being present.
- New modular framework for URL operations. This framework directly supports operation
on `http(s)`, `ssh`, and `file` URLs, and can be extended with custom functionality
for additional protocols or even interaction with specific individual servers.
The basic operations `download`, `upload`, `delete`, and `stat` are recognized,
and can be implemented. The framework offers uniform progress reporting and
simultaneous content has computation. This framework is meant to replace and
extend the downloader/provide framework in the DataLad core package. In contrast
to its predecessor it is integrated with the new credential framework, and
operations beyond downloading.
- `git-annex-remote-uncurl` is a special remote that exposes the new URL
operations framework via git-annex. It provides flexible means to compose
and rewrite URLs (e.g., to compensate for storage infrastructure changes)
without having to modify individual URLs recorded in datasets. It enables
seamless transitions between any services and protocols supported by the
framework. This special remote can replace the `datalad` special remote
provided by the DataLad core package.
- A `download` command is provided as a front-end for the new modular URL
operations framework.
- A `python-requests` compatible authentication handler (`DataladAuth`) that
interfaces DataLad's credential system.
- Boosted throughput of DataLad's `runner` component for command execution.
- Substantially more comprehensive replacement for DataLad's `constraints` system
for type conversion and parameter validation.
- Windows and Mac client support for RIA store access.
- A `next-status` command that is A LOT faster than `status`, and offers
a `mono` recursion mode that shows modifications of nested dataset
hierarchies relative to the state of the root dataset.
Requires Git v2.31 (or later).
## Summary of additional features for DataLad extension development
- Framework for uniform command parameter validation. Regardless of the used
API (Python, CLI, or GUI), command parameters are uniformly validated. This
facilitates a stricter separation of parameter specification (and validation)
from the actual implementation of a command. The latter can now focus on a
command's logic only, while the former enables more uniform and more
comprehensive validation and error reporting. Beyond per-parameter validation
and type-conversion also inter-parameter dependency validation and value
transformations are supported.
- Improved composition of importable functionality. Key components for `commands`,
`annexremotes`, `datasets` (etc) are collected in topical top-level modules that
provide "all" necessary pieces in a single place.
- `webdav_server` fixture that automatically deploys a local WebDAV
server.
- Utilities for HTTP handling
- `probe_url()` discovers redirects and authentication requirements for an HTTP
URL
- `get_auth_realm()` returns a label for an authentication realm that can be used
to query for matching credentials
- Utilities for special remote credential management:
- `get_specialremote_credential_properties()` inspects a special remote and returns
properties for querying a credential store for matching credentials
- `update_specialremote_credential()` updates a credential in a store after
successful use
- `get_specialremote_credential_envpatch()` returns a suitable environment "patch"
from a credential for a particular special remote type
- Helper for runtime-patching other datalad code (`datalad_next.utils.patch`)
- Base class for implementing custom `git-annex` backends.
- A set of `pytest` fixtures to:
- check that no global configuration side-effects are left behind by a test
- check that no secrets are left behind by a test
- provide a temporary configuration that is isolated from a user environment
and from other tests
- provide a temporary secret store that is isolated from a user environment
and from other tests
- provide a temporary credential manager to perform credential deployment
and manipulation isolated from a user environment and from other tests
- An `iter_subproc()` helper that enable communication with subprocesses
via input/output iterables.
- A `shell` context manager that enables interaction with (remote) shells,
including support for input/output iterables for each shell-command execution
within the context.
## Patching the DataLad core package.
Some of the features described above rely on a modification of the DataLad core
package itself, rather than coming in the form of additional commands. Loading
this extension causes a range of patches to be applied to the `datalad` package
to enable them. A comprehensive description of the current set of patch is
available at http://docs.datalad.org/projects/next/en/latest/#datalad-patches
## Developing with DataLad NEXT
This extension package moves fast in comparison to the core package. Nevertheless,
attention is paid to API stability, adequate semantic versioning, and informative
changelogs.
### Public vs internal API
Anything that can be imported directly from any of the sub-packages in
`datalad_next` is considered to be part of the public API. Changes to this API
determine the versioning, and development is done with the aim to keep this API
as stable as possible. This includes signatures and return value behavior.
As an example: `from datalad_next.runners import iter_git_subproc` imports a
part of the public API, but `from datalad_next.runners.git import
iter_git_subproc` does not.
### Use of the internal API
Developers can obviously use parts of the non-public API. However, this should
only be done with the understanding that these components may change from one
release to another, with no guarantee of transition periods, deprecation
warnings, etc.
Developers are advised to never reuse any components with names starting with
`_` (underscore). Their use should be limited to their individual subpackage.
## Acknowledgements
This DataLad extension was developed with funding from the Deutsche
Forschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451
([431549029](https://gepris.dfg.de/gepris/projekt/431549029), INF project).
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://psychoinformatics.de/"><img src="https://avatars.githubusercontent.com/u/136479?v=4?s=100" width="100px;" alt="Michael Hanke"/><br /><sub><b>Michael Hanke</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/issues?q=author%3Amih" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=mih" title="Code">π»</a> <a href="#content-mih" title="Content">π</a> <a href="#design-mih" title="Design">π¨</a> <a href="https://github.com/datalad/datalad-next/commits?author=mih" title="Documentation">π</a> <a href="#financial-mih" title="Financial">π΅</a> <a href="#fundingFinding-mih" title="Funding Finding">π</a> <a href="#ideas-mih" title="Ideas, Planning, & Feedback">π€</a> <a href="#infra-mih" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="#maintenance-mih" title="Maintenance">π§</a> <a href="#mentoring-mih" title="Mentoring">π§βπ«</a> <a href="#platform-mih" title="Packaging/porting to new platform">π¦</a> <a href="#projectManagement-mih" title="Project Management">π</a> <a href="https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Amih" title="Reviewed Pull Requests">π</a> <a href="#talk-mih" title="Talks">π’</a> <a href="https://github.com/datalad/datalad-next/commits?author=mih" title="Tests">β οΈ</a> <a href="#tool-mih" title="Tools">π§</a> <a href="#userTesting-mih" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/catetrai"><img src="https://avatars.githubusercontent.com/u/18424941?v=4?s=100" width="100px;" alt="catetrai"/><br /><sub><b>catetrai</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/commits?author=catetrai" title="Code">π»</a> <a href="#design-catetrai" title="Design">π¨</a> <a href="https://github.com/datalad/datalad-next/commits?author=catetrai" title="Documentation">π</a> <a href="#ideas-catetrai" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/datalad/datalad-next/commits?author=catetrai" title="Tests">β οΈ</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/effigies"><img src="https://avatars.githubusercontent.com/u/83442?v=4?s=100" width="100px;" alt="Chris Markiewicz"/><br /><sub><b>Chris Markiewicz</b></sub></a><br /><a href="#maintenance-effigies" title="Maintenance">π§</a> <a href="https://github.com/datalad/datalad-next/commits?author=effigies" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mslw"><img src="https://avatars.githubusercontent.com/u/11985212?v=4?s=100" width="100px;" alt="MichaΕ Szczepanik"/><br /><sub><b>MichaΕ Szczepanik</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/issues?q=author%3Amslw" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=mslw" title="Code">π»</a> <a href="#content-mslw" title="Content">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=mslw" title="Documentation">π</a> <a href="#example-mslw" title="Examples">π‘</a> <a href="#ideas-mslw" title="Ideas, Planning, & Feedback">π€</a> <a href="#infra-mslw" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="#maintenance-mslw" title="Maintenance">π§</a> <a href="https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Amslw" title="Reviewed Pull Requests">π</a> <a href="#talk-mslw" title="Talks">π’</a> <a href="https://github.com/datalad/datalad-next/commits?author=mslw" title="Tests">β οΈ</a> <a href="#tutorial-mslw" title="Tutorials">β
</a> <a href="#userTesting-mslw" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://jsheunis.github.io/"><img src="https://avatars.githubusercontent.com/u/10141237?v=4?s=100" width="100px;" alt="Stephan Heunis"/><br /><sub><b>Stephan Heunis</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/issues?q=author%3Ajsheunis" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=jsheunis" title="Code">π»</a> <a href="https://github.com/datalad/datalad-next/commits?author=jsheunis" title="Documentation">π</a> <a href="#ideas-jsheunis" title="Ideas, Planning, & Feedback">π€</a> <a href="#maintenance-jsheunis" title="Maintenance">π§</a> <a href="#talk-jsheunis" title="Talks">π’</a> <a href="#userTesting-jsheunis" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/bpoldrack"><img src="https://avatars.githubusercontent.com/u/10498301?v=4?s=100" width="100px;" alt="Benjamin Poldrack"/><br /><sub><b>Benjamin Poldrack</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/issues?q=author%3Abpoldrack" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=bpoldrack" title="Code">π»</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/yarikoptic"><img src="https://avatars.githubusercontent.com/u/39889?v=4?s=100" width="100px;" alt="Yaroslav Halchenko"/><br /><sub><b>Yaroslav Halchenko</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/issues?q=author%3Ayarikoptic" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=yarikoptic" title="Code">π»</a> <a href="#infra-yarikoptic" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="#maintenance-yarikoptic" title="Maintenance">π§</a> <a href="#tool-yarikoptic" title="Tools">π§</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/christian-monch"><img src="https://avatars.githubusercontent.com/u/17925232?v=4?s=100" width="100px;" alt="Christian MΓΆnch"/><br /><sub><b>Christian MΓΆnch</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/commits?author=christian-monch" title="Code">π»</a> <a href="#design-christian-monch" title="Design">π¨</a> <a href="https://github.com/datalad/datalad-next/commits?author=christian-monch" title="Documentation">π</a> <a href="#ideas-christian-monch" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Achristian-monch" title="Reviewed Pull Requests">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=christian-monch" title="Tests">β οΈ</a> <a href="#userTesting-christian-monch" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/adswa"><img src="https://avatars.githubusercontent.com/u/29738718?v=4?s=100" width="100px;" alt="Adina Wagner"/><br /><sub><b>Adina Wagner</b></sub></a><br /><a href="#a11y-adswa" title="Accessibility">οΈοΈοΈοΈβΏοΈ</a> <a href="https://github.com/datalad/datalad-next/issues?q=author%3Aadswa" title="Bug reports">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=adswa" title="Code">π»</a> <a href="https://github.com/datalad/datalad-next/commits?author=adswa" title="Documentation">π</a> <a href="#example-adswa" title="Examples">π‘</a> <a href="#maintenance-adswa" title="Maintenance">π§</a> <a href="#projectManagement-adswa" title="Project Management">π</a> <a href="https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Aadswa" title="Reviewed Pull Requests">π</a> <a href="#talk-adswa" title="Talks">π’</a> <a href="https://github.com/datalad/datalad-next/commits?author=adswa" title="Tests">β οΈ</a> <a href="#tutorial-adswa" title="Tutorials">β
</a> <a href="#userTesting-adswa" title="User Testing">π</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jwodder"><img src="https://avatars.githubusercontent.com/u/98207?v=4?s=100" width="100px;" alt="John T. Wodder II"/><br /><sub><b>John T. Wodder II</b></sub></a><br /><a href="https://github.com/datalad/datalad-next/commits?author=jwodder" title="Code">π»</a> <a href="#infra-jwodder" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="https://github.com/datalad/datalad-next/commits?author=jwodder" title="Tests">β οΈ</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Raw data
{
"_id": null,
"home_page": "https://github.com/datalad/datalad-next",
"name": "datalad-next",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "The DataLad Team and Contributors",
"author_email": "team@datalad.org",
"download_url": "https://files.pythonhosted.org/packages/7b/c5/90f6e8671031aca45ed01da41b504f9f6bce08141769d381e0b000a9edb0/datalad_next-1.5.0.tar.gz",
"platform": null,
"description": "# DataLad NEXT extension\n\n[](#contributors)\n[](https://ci.appveyor.com/project/mih/datalad-next/branch/main)\n[](https://codecov.io/gh/datalad/datalad-next)\n[](https://github.com/datalad/datalad-next/actions?query=workflow%3Adocs)\n[](http://docs.datalad.org/projects/next/en/latest/?badge=latest)\n[](https://opensource.org/licenses/MIT)\n[](https://GitHub.com/datalad/datalad-next/releases/)\n[](https://pypi.python.org/pypi/datalad-next/)\n[](https://doi.org/10.5281/zenodo.6833099)\n\nThis DataLad extension can be thought of as a staging area for additional\nfunctionality, or for improved performance and user experience. Unlike other\ntopical or more experimental extensions, the focus here is on functionality\nwith broad applicability. This extension is a suitable dependency for other\nsoftware packages that intend to build on this improved set of functionality.\n\n## Installation\n\n```\n# create and enter a new virtual environment (optional)\n$ virtualenv --python=python3 ~/env/dl-next\n$ . ~/env/dl-next/bin/activate\n# install from PyPi\n$ python -m pip install datalad-next\n```\n\n## How to use\n\nAdditional commands provided by this extension are immediately available\nafter installation. However, in order to fully benefit from all improvements,\nthe extension has to be enabled for auto-loading by executing:\n\n git config --global --add datalad.extensions.load next\n\nDoing so will enable the extension to also alter the behavior the core DataLad\npackage and its commands.\n\n## Summary of functionality provided by this extension\n\n- A replacement sub-system for credential handling that is able to handle arbitrary\n properties for annotating a secret, and facilitates determining suitable\n credentials while minimizing avoidable user interaction, without compromising\n configurability. A convenience method is provided that implements a standard\n workflow for obtaining a credential.\n- A user-facing `credentials` command to set, remove, and query credentials.\n- The `create-sibling-...` commands for the platforms GitHub, GIN, GOGS, Gitea\n are equipped with improved credential handling that, for example, only stores\n entered credentials after they were confirmed to work, or auto-selects the\n most recently used, matching credentials, when none are specified.\n- A `create-sibling-webdav` command for hosting datasets on a WebDAV server via\n a sibling tandem for Git history and file storage. Datasets hosted on WebDAV\n in this fashion are cloneable with `datalad-clone`. A full annex setup\n for storing complete datasets with historical file content version, and an\n additional mode for depositing single-version dataset snapshot are supported.\n The latter enables convenient collaboration with audiences that are not using\n DataLad, because all files are browsable via a WebDAV server's point-and-click\n user interface.\n- Enhance `datalad-push` to automatically export files to git-annex special\n remotes configured with `exporttree=yes`.\n- Speed-up `datalad-push` when processing non-git special remotes. This particularly\n benefits less efficient hosting scenarios like WebDAV.\n- Enhance `datalad-siblings enable` (`AnnexRepo.enable_remote()`) to automatically\n deploy credentials for git-annex special remotes that require them.\n- `git-remote-datalad-annex` is a Git remote helper to push/fetch to any\n location accessible by any git-annex special remote.\n- `git-annex-backend-XDLRA` (originally available from the `mihextras` extension)\n is a custom external git-annex backend used by `git-remote-datalad-annex`. A base\n class to facilitate development of external backends in Python is also provided.\n- Enhance `datalad-configuration` to support getting configuration from \"global\"\n scope without a dataset being present.\n- New modular framework for URL operations. This framework directly supports operation\n on `http(s)`, `ssh`, and `file` URLs, and can be extended with custom functionality\n for additional protocols or even interaction with specific individual servers.\n The basic operations `download`, `upload`, `delete`, and `stat` are recognized,\n and can be implemented. The framework offers uniform progress reporting and\n simultaneous content has computation. This framework is meant to replace and\n extend the downloader/provide framework in the DataLad core package. In contrast\n to its predecessor it is integrated with the new credential framework, and\n operations beyond downloading.\n- `git-annex-remote-uncurl` is a special remote that exposes the new URL\n operations framework via git-annex. It provides flexible means to compose\n and rewrite URLs (e.g., to compensate for storage infrastructure changes)\n without having to modify individual URLs recorded in datasets. It enables\n seamless transitions between any services and protocols supported by the\n framework. This special remote can replace the `datalad` special remote\n provided by the DataLad core package.\n- A `download` command is provided as a front-end for the new modular URL\n operations framework.\n- A `python-requests` compatible authentication handler (`DataladAuth`) that\n interfaces DataLad's credential system.\n- Boosted throughput of DataLad's `runner` component for command execution.\n- Substantially more comprehensive replacement for DataLad's `constraints` system\n for type conversion and parameter validation.\n- Windows and Mac client support for RIA store access.\n- A `next-status` command that is A LOT faster than `status`, and offers\n a `mono` recursion mode that shows modifications of nested dataset\n hierarchies relative to the state of the root dataset.\n Requires Git v2.31 (or later).\n\n## Summary of additional features for DataLad extension development\n\n- Framework for uniform command parameter validation. Regardless of the used\n API (Python, CLI, or GUI), command parameters are uniformly validated. This\n facilitates a stricter separation of parameter specification (and validation)\n from the actual implementation of a command. The latter can now focus on a\n command's logic only, while the former enables more uniform and more\n comprehensive validation and error reporting. Beyond per-parameter validation\n and type-conversion also inter-parameter dependency validation and value\n transformations are supported.\n- Improved composition of importable functionality. Key components for `commands`,\n `annexremotes`, `datasets` (etc) are collected in topical top-level modules that\n provide \"all\" necessary pieces in a single place.\n- `webdav_server` fixture that automatically deploys a local WebDAV\n server.\n- Utilities for HTTP handling\n - `probe_url()` discovers redirects and authentication requirements for an HTTP\n URL\n - `get_auth_realm()` returns a label for an authentication realm that can be used\n to query for matching credentials\n- Utilities for special remote credential management:\n - `get_specialremote_credential_properties()` inspects a special remote and returns\n properties for querying a credential store for matching credentials\n - `update_specialremote_credential()` updates a credential in a store after\n successful use\n - `get_specialremote_credential_envpatch()` returns a suitable environment \"patch\"\n from a credential for a particular special remote type\n- Helper for runtime-patching other datalad code (`datalad_next.utils.patch`)\n- Base class for implementing custom `git-annex` backends.\n- A set of `pytest` fixtures to:\n - check that no global configuration side-effects are left behind by a test\n - check that no secrets are left behind by a test\n - provide a temporary configuration that is isolated from a user environment\n and from other tests\n - provide a temporary secret store that is isolated from a user environment\n and from other tests\n - provide a temporary credential manager to perform credential deployment\n and manipulation isolated from a user environment and from other tests\n- An `iter_subproc()` helper that enable communication with subprocesses\n via input/output iterables.\n- A `shell` context manager that enables interaction with (remote) shells,\n including support for input/output iterables for each shell-command execution\n within the context.\n\n## Patching the DataLad core package.\n\nSome of the features described above rely on a modification of the DataLad core\npackage itself, rather than coming in the form of additional commands. Loading\nthis extension causes a range of patches to be applied to the `datalad` package\nto enable them. A comprehensive description of the current set of patch is\navailable at http://docs.datalad.org/projects/next/en/latest/#datalad-patches\n\n## Developing with DataLad NEXT\n\nThis extension package moves fast in comparison to the core package. Nevertheless,\nattention is paid to API stability, adequate semantic versioning, and informative\nchangelogs.\n\n### Public vs internal API\n\nAnything that can be imported directly from any of the sub-packages in\n`datalad_next` is considered to be part of the public API. Changes to this API\ndetermine the versioning, and development is done with the aim to keep this API\nas stable as possible. This includes signatures and return value behavior.\n\nAs an example: `from datalad_next.runners import iter_git_subproc` imports a\npart of the public API, but `from datalad_next.runners.git import\niter_git_subproc` does not.\n\n### Use of the internal API\n\nDevelopers can obviously use parts of the non-public API. However, this should\nonly be done with the understanding that these components may change from one\nrelease to another, with no guarantee of transition periods, deprecation\nwarnings, etc.\n\nDevelopers are advised to never reuse any components with names starting with\n`_` (underscore). Their use should be limited to their individual subpackage.\n\n## Acknowledgements\n\nThis DataLad extension was developed with funding from the Deutsche\nForschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451\n([431549029](https://gepris.dfg.de/gepris/projekt/431549029), INF project).\n\n\n## Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://psychoinformatics.de/\"><img src=\"https://avatars.githubusercontent.com/u/136479?v=4?s=100\" width=\"100px;\" alt=\"Michael Hanke\"/><br /><sub><b>Michael Hanke</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Amih\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mih\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#content-mih\" title=\"Content\">\ud83d\udd8b</a> <a href=\"#design-mih\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mih\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#financial-mih\" title=\"Financial\">\ud83d\udcb5</a> <a href=\"#fundingFinding-mih\" title=\"Funding Finding\">\ud83d\udd0d</a> <a href=\"#ideas-mih\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#infra-mih\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"#maintenance-mih\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#mentoring-mih\" title=\"Mentoring\">\ud83e\uddd1\u200d\ud83c\udfeb</a> <a href=\"#platform-mih\" title=\"Packaging/porting to new platform\">\ud83d\udce6</a> <a href=\"#projectManagement-mih\" title=\"Project Management\">\ud83d\udcc6</a> <a href=\"https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Amih\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#talk-mih\" title=\"Talks\">\ud83d\udce2</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mih\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#tool-mih\" title=\"Tools\">\ud83d\udd27</a> <a href=\"#userTesting-mih\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/catetrai\"><img src=\"https://avatars.githubusercontent.com/u/18424941?v=4?s=100\" width=\"100px;\" alt=\"catetrai\"/><br /><sub><b>catetrai</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/commits?author=catetrai\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#design-catetrai\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=catetrai\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#ideas-catetrai\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=catetrai\" title=\"Tests\">\u26a0\ufe0f</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/effigies\"><img src=\"https://avatars.githubusercontent.com/u/83442?v=4?s=100\" width=\"100px;\" alt=\"Chris Markiewicz\"/><br /><sub><b>Chris Markiewicz</b></sub></a><br /><a href=\"#maintenance-effigies\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=effigies\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/mslw\"><img src=\"https://avatars.githubusercontent.com/u/11985212?v=4?s=100\" width=\"100px;\" alt=\"Micha\u0142 Szczepanik\"/><br /><sub><b>Micha\u0142 Szczepanik</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Amslw\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mslw\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#content-mslw\" title=\"Content\">\ud83d\udd8b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mslw\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#example-mslw\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#ideas-mslw\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#infra-mslw\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"#maintenance-mslw\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Amslw\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#talk-mslw\" title=\"Talks\">\ud83d\udce2</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=mslw\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#tutorial-mslw\" title=\"Tutorials\">\u2705</a> <a href=\"#userTesting-mslw\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://jsheunis.github.io/\"><img src=\"https://avatars.githubusercontent.com/u/10141237?v=4?s=100\" width=\"100px;\" alt=\"Stephan Heunis\"/><br /><sub><b>Stephan Heunis</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Ajsheunis\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=jsheunis\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=jsheunis\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#ideas-jsheunis\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#maintenance-jsheunis\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#talk-jsheunis\" title=\"Talks\">\ud83d\udce2</a> <a href=\"#userTesting-jsheunis\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/bpoldrack\"><img src=\"https://avatars.githubusercontent.com/u/10498301?v=4?s=100\" width=\"100px;\" alt=\"Benjamin Poldrack\"/><br /><sub><b>Benjamin Poldrack</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Abpoldrack\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=bpoldrack\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/yarikoptic\"><img src=\"https://avatars.githubusercontent.com/u/39889?v=4?s=100\" width=\"100px;\" alt=\"Yaroslav Halchenko\"/><br /><sub><b>Yaroslav Halchenko</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Ayarikoptic\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=yarikoptic\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#infra-yarikoptic\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"#maintenance-yarikoptic\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#tool-yarikoptic\" title=\"Tools\">\ud83d\udd27</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/christian-monch\"><img src=\"https://avatars.githubusercontent.com/u/17925232?v=4?s=100\" width=\"100px;\" alt=\"Christian M\u00f6nch\"/><br /><sub><b>Christian M\u00f6nch</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/commits?author=christian-monch\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#design-christian-monch\" title=\"Design\">\ud83c\udfa8</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=christian-monch\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#ideas-christian-monch\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Achristian-monch\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=christian-monch\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#userTesting-christian-monch\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/adswa\"><img src=\"https://avatars.githubusercontent.com/u/29738718?v=4?s=100\" width=\"100px;\" alt=\"Adina Wagner\"/><br /><sub><b>Adina Wagner</b></sub></a><br /><a href=\"#a11y-adswa\" title=\"Accessibility\">\ufe0f\ufe0f\ufe0f\ufe0f\u267f\ufe0f</a> <a href=\"https://github.com/datalad/datalad-next/issues?q=author%3Aadswa\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=adswa\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=adswa\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#example-adswa\" title=\"Examples\">\ud83d\udca1</a> <a href=\"#maintenance-adswa\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#projectManagement-adswa\" title=\"Project Management\">\ud83d\udcc6</a> <a href=\"https://github.com/datalad/datalad-next/pulls?q=is%3Apr+reviewed-by%3Aadswa\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a> <a href=\"#talk-adswa\" title=\"Talks\">\ud83d\udce2</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=adswa\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"#tutorial-adswa\" title=\"Tutorials\">\u2705</a> <a href=\"#userTesting-adswa\" title=\"User Testing\">\ud83d\udcd3</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/jwodder\"><img src=\"https://avatars.githubusercontent.com/u/98207?v=4?s=100\" width=\"100px;\" alt=\"John T. Wodder II\"/><br /><sub><b>John T. Wodder II</b></sub></a><br /><a href=\"https://github.com/datalad/datalad-next/commits?author=jwodder\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#infra-jwodder\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"https://github.com/datalad/datalad-next/commits?author=jwodder\" title=\"Tests\">\u26a0\ufe0f</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "What is next in DataLad",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/datalad/datalad-next"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb504b6ef8d68f7b5dda0bb13e6a944bcac978d590960b70b5b166c84c3c9b00",
"md5": "cdf34bfc2b4963aaa409661eaea420e6",
"sha256": "a49168eb9113c476f0ffddd6808faa2d5886efe365bd2b6c1452bc37b49cb395"
},
"downloads": -1,
"filename": "datalad_next-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cdf34bfc2b4963aaa409661eaea420e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 485355,
"upload_time": "2024-06-16T13:08:13",
"upload_time_iso_8601": "2024-06-16T13:08:13.732861Z",
"url": "https://files.pythonhosted.org/packages/eb/50/4b6ef8d68f7b5dda0bb13e6a944bcac978d590960b70b5b166c84c3c9b00/datalad_next-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7bc590f6e8671031aca45ed01da41b504f9f6bce08141769d381e0b000a9edb0",
"md5": "d28b4cf284bf1cb6b39c32f903429052",
"sha256": "02f950aff5c03f0e5b91b011691496e2df9346a4bd73234eafad60f7341bfc05"
},
"downloads": -1,
"filename": "datalad_next-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "d28b4cf284bf1cb6b39c32f903429052",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 470392,
"upload_time": "2024-06-16T13:08:16",
"upload_time_iso_8601": "2024-06-16T13:08:16.771667Z",
"url": "https://files.pythonhosted.org/packages/7b/c5/90f6e8671031aca45ed01da41b504f9f6bce08141769d381e0b000a9edb0/datalad_next-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 13:08:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "datalad",
"github_project": "datalad-next",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"lcname": "datalad-next"
}
JSON
