semvec/pypi-packages huggingface dataset:
dtool-config 0.4.1
Plugin to make configuration of dtool easier
License: MIT

dtool CLI commands for configuring dtool settings
=================================================

.. image:: https://badge.fury.io/py/dtool-config.svg
   :target: http://badge.fury.io/py/dtool-config
   :alt: PyPi package

.. image:: https://travis-ci.org/jic-dtool/dtool-config.svg?branch=master
   :target: https://travis-ci.org/jic-dtool/dtool-config
   :alt: Travis CI build status (Linux)

.. image:: https://codecov.io/github/jic-dtool/dtool-config/coverage.svg?branch=master
   :target: https://codecov.io/github/jic-dtool/dtool-config?branch=master
   :alt: Code Coverage


Installation
------------

Installation using ``pip``::

    pip install dtool-config

Example usage
-------------

Setting the user name and email::

    dtool config user name "Marie Curie"
    dtool config user email marie.curie@sorbonne-universite.fr

Setting the download cache::

    mkdir /tmp/dtool
    dtool config cache /tmp/dtool


Related packages
----------------

- `dtoolcore <https://github.com/jic-dtool/dtoolcore>`_
- `dtool-cli <https://github.com/jic-dtool/dtool-cli>`_
- `dtool-info <https://github.com/jic-dtool/dtool-create>`_
- `dtool-create <https://github.com/jic-dtool/dtool-create>`_
dtool-cli 0.7.1
Data management command line tool: dtool.
License: MIT

README
======

Data management command line tool: dtool.

Overview
--------

The ``dtool-cli`` python package provides a skeleton command line interface to
dtool that other "dtool" command line packages can be plugged into.

It makes use of `click <https://github.com/pallets/click>`_ and `click-plugins
<https://github.com/click-contrib/click-plugins>`_.


Creating a plugin
-----------------

The ``dtool-cli`` plug-in system exposes name space ``dtool.cli`` for
registering commands.


To create a ``dtool-cli`` plug-in, create a Python package and register the
function of interest in the ``setup.py`` file.  Below is the content of a
hypothetical ``dtool_create/__init__.py`` file::

    import click

    @click.command()
    def create():
        print("Creating dataset...")

    @click.command()
    def freeze():
        print("Freezing dataset...")


To create an entry point for this function add the below in the ``setup.py``::

    from setuptools import setup

    setup(
        ...
        entry_points={
            "dtool.cli": [
                "create=dtool_create:create",
                "freeze=dtool_create:freeze",
            ],
        },
        ...
    )



Installation
------------

To install the dtool-cli package.

.. code-block:: bash

    cd dtool-cli
    python setup.py install
dtool-info 0.16.2
Dtool plugin for getting information about datasets
License: MIT

dtool CLI commands for getting information about datasets
=========================================================

.. image:: https://badge.fury.io/py/dtool-info.svg
   :target: http://badge.fury.io/py/dtool-info
   :alt: PyPi package

.. image:: https://travis-ci.org/jic-dtool/dtool-info.svg?branch=master
   :target: https://travis-ci.org/jic-dtool/dtool-info
   :alt: Travis CI build status (Linux)

.. image:: https://codecov.io/github/jic-dtool/dtool-info/coverage.svg?branch=master
   :target: https://codecov.io/github/jic-dtool/dtool-info?branch=master
   :alt: Code Coverage


Installation
------------

.. code-block:: bash

    pip install dtool-info


Example usage
-------------

Listing datasets in ``~/my_dataset`` directory::

    dtool ls ~/my_datasets

Getting summary information about a dataset::

    dtool summary ~/my_datasets/example_dataset

See the `dtool documentation <http://dtool.readthedocs.io>`_ for more detail.


Related packages
----------------

- `dtoolcore <https://github.com/jic-dtool/dtoolcore>`_
- `dtool-cli <https://github.com/jic-dtool/dtool-cli>`_
- `dtool-create <https://github.com/jic-dtool/dtool-create>`_