An open API service indexing awesome lists of open source software.

https://github.com/datalad/ria-tools

Collection of scripts for running a datalad RIA store
https://github.com/datalad/ria-tools

Last synced: 4 months ago
JSON representation

Collection of scripts for running a datalad RIA store

Awesome Lists containing this project

README

          

# RIA-Tools

# NOTE: THIS IS UNDER CONSTRUCTION AND NOT UP-TO-DATE!

This is supposed to become a collection of scripts to setup and maintain a
datalad RIA store. For now this is not intended to be an installable package,
since generic deployment and acceptable dependencies aren't obvious. Instead
it's an entry point showing what you can (and may be have to) do and how.

## Data store maintainer scripts

Various scripts are provided under `maint/`. The data store location is not hardcoded.

- hammerpants_archiveobjs

Move or copy annex objects into a 7z archive at the dataset location in the store

- hammerpants_dsdeps

Report dataset IDs of any subdatasets of a dataset

- hammerpants_dsinfo

Resolve a dataset location in a store from a variety of argument flavors (store path + ID; dataset path; PWD at a dataset location)

- hammerpants_gc

Clean-up and compact a dataset representation in the store (does not archive objects)

- hammerpants_gc_all

Run clean-ups on all datasets in a store

- hammerpants_lastupdated

Report who modified a dataset when most recently (for a single or all datasets in a store)

- hammerpants_ncommits

Report the number of commits in the master branch of a dataset (for a single or all datasets in a store)

- hammerpants_nogitrepo

List all dataset entries in a store without an associated Git repo.


## OUTDATED - base requirements for config procedure

- Server side:

7z needs to be in the path.

- Client side:

the storage's base path needs to be configured via
annex.ria-remote.inm7-storage.base-path

for SSH Connection a host needs to be specified via
annex.ria-remote.inm7-storage.ssh-host Any SSH config will be respected,
but needs to reference that very host, of course. Don't forget, that you may
need to configure your username for this host.

Although those configs could be done at the dataset level, they should be
done at user or system level. Note, that this means, that your local config
overrides whatever config may be stored in the dataset. This allows to access
that storage via SSH from your computer, while another clone of the same
dataset might access it via the local filesystem on brainbfast. If no host is
configured, the base_path is assumed to be a local path. To explicitly
configure no host (for overriding) assign the value 0 to the respective config
variable.