Skip to main content

Datalad extension to apply lgpd patterns

Project description

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 version, clone this repository and install the demo extension via

pip install -e . or pip install lgpdextension-datalad

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

% datalad --help |grep -B2 -A2 hello
*DataLad command suite*

  lgpd-extension
      Apply lgpd patterns

    -p | --pathfile
      Full address to configuration file
    -c | --createbase
      Create the default configuration file

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_lgpdextension with datalad_<newname> (hint: git grep datalad_lgpdextension should find all spots).
  • Delete the example command implementation in datalad_lgpdextension/__init__.py by (re)moving the lgpdextension class.
  • Implement a new command, and adjust the command_suite in datalad_lgpdextension/__init__.py to point to it.
  • Replace lgpd_extension with the name of the new command in datalad_lgpdextension/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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datalad-lgpdextension-0.5.0.tar.gz (47.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page