Data

Tools

Indexes

Applications

Experiments

Open Source Science

datalad-metalad-extractor-template

This repository contains a template to create datalad-metalad extractors. It contains an example for a dataset-level extractor and for a file-level extractor

https://github.com/datalad/datalad-metalad-extractor-template

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

This repository contains a template to create datalad-metalad extractors. It contains an example for a dataset-level extractor and for a file-level extractor

Basic Info
  • Host: GitHub
  • Owner: datalad
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 31.3 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 4 years ago · Last pushed almost 4 years ago
Metadata Files
Readme License Zenodo

README.md

DataLad extension template

Build status codecov.io crippled-filesystems docs

This repository contains an extension template that can serve as a starting point for implementing a DataLad 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, 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_<newname> (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. Refer to docs/README.md for more information on documentation building, testing and publishing.
  • Replace this README.
  • Update setup.cfg with appropriate metadata on the new extension.

You can consider filling in the provided .zenodo.json file with contributor information and meta data to acknowledge contributors and describe the publication record that is created when you make your code citeable by archiving it using zenodo.org. You may also want to consider acknowledging contributors with the allcontributors bot.

Owner

  • Name: DataLad
  • Login: datalad
  • Kind: organization
  • Email: team@datalad.org
  • Location: USA&Germany

Data distribution and management platform

GitHub Events

Total
Last Year

Dependencies

.github/workflows/docbuild.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite
.github/workflows/test_crippledfs.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite
requirements-devel.txt pypi
  • coverage * development
  • nose * development
  • sphinx * development
  • sphinx_rtd_theme * development