Skip to content

Commit

Permalink
Update README and CHANGELOG with info on uncurl
Browse files Browse the repository at this point in the history
Closes #206
  • Loading branch information
mih committed Jan 20, 2023
1 parent 22f0fdc commit 518f14d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@
`datalad_next.url_operations.any._urlscheme_handler` contains a (patch-able)
mapping of scheme identifiers to handler classes.

The `uncurl` special remote makes this URL operations framework accessible
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.

- A `python-requests` compatible authentication handler (`DataladAuth`) that
interfaces DataLad's credential system has been added.

Expand Down
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ package and its commands.
- 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.
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
Expand All @@ -69,13 +70,24 @@ package and its commands.
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.
- A `download` command as a front-end for a modular URL operation framework.
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 `sniff` are understood, and can be
implemented. The framework offers uniform progress reporting and simultaneous
content has computation.
- 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 `sniff` 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.
Expand Down

0 comments on commit 518f14d

Please sign in to comment.