https://github.com/datalad/datalad-eosc

DataLad extension for working with European Open Science Cloud (EOSC) services
https://github.com/datalad/datalad-eosc

Last synced: 4 months ago
JSON representation

DataLad extension for working with European Open Science Cloud (EOSC) services

• Host: GitHub
• URL: https://github.com/datalad/datalad-eosc
• Owner: datalad
• License: other
• Created: 2021-03-11T10:02:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-11T10:02:01.000Z (about 5 years ago)
• Last Synced: 2025-09-11T10:49:54.930Z (9 months ago)
• Language: Python
• Size: 34.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DataLad extension template

[![Build status](https://ci.appveyor.com/api/projects/status/g9von5wtpoidcecy/branch/master?svg=true)](https://ci.appveyor.com/project/mih/datalad-extension-template/branch/master) [![codecov.io](https://codecov.io/github/datalad/datalad-extension-template/coverage.svg?branch=master)](https://codecov.io/github/datalad/datalad-extension-template?branch=master) [![crippled-filesystems](https://github.com/datalad/datalad-extension-template/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-extension-template/actions?query=workflow%3Acrippled-filesystems) [![docs](https://github.com/datalad/datalad-extension-template/workflows/docs/badge.svg)](https://github.com/datalad/datalad-extension-template/actions?query=workflow%3Adocs)

This repository contains an extension template that can serve as a starting point

for implementing a [DataLad](http://datalad.org) extension. An extension can

provide any number of additional DataLad commands that are automatically

included in DataLad's command line and Python API.

For a demo, clone this repository and install the demo extension via

    pip install -e .

DataLad will now expose a new command suite with a `hello...` command.

    % datalad --help |grep -B2 -A2 hello

    *Demo DataLad command suite*

      hello-cmd

          Short description of the command

To start implementing your own extension, [use this

template](https://github.com/datalad/datalad-extension-template/generate), and

adjust as necessary. A good approach is to

- Pick a name for the new extension.

- Look through the sources and replace `datalad_helloworld` with

  `datalad_` (hint: `git grep datalad_helloworld` should find all

  spots).

- Delete the example command implementation in `datalad_helloworld/__init__.py`

  by (re)moving the `HelloWorld` class.

- Implement a new command, and adjust the `command_suite` in

  `datalad_helloworld/__init__.py` to point to it.

- Replace `hello_cmd` with the name of the new command in

  `datalad_helloworld/tests/test_register.py` to automatically test whether the

  new extension installs correctly.

- Adjust the documentation in `docs/source/index.rst`.

- Replace this README.

- Update `setup.cfg` with appropriate metadata on the new extension.

You can consider filling in the provided [.zenodo.json](.zenodo.json) file with

contributor information and [meta data](https://developers.zenodo.org/#representation)

to acknowledge contributors and describe the publication record that is created when

[you make your code citeable](https://guides.github.com/activities/citable-code/)

by archiving it using [zenodo.org](https://zenodo.org/). You may also want to

consider acknowledging contributors with the

[allcontributors bot](https://allcontributors.org/docs/en/bot/overview).