.. image:: https://img.shields.io/pypi/v/datakit-core.svg :target: https://pypi.python.org/pypi/datakit-core

.. image:: https://github.com/associatedpress/datakit-core/actions/workflows/main.yml/badge.svg :target: https://github.com/associatedpress/datakit-core/actions/workflows/main.yml :alt: Build status on Github Actions

.. image:: https://readthedocs.org/projects/datakit-core/badge/?version=latest :target: https://datakit-core.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

======= Datakit

Datakit is a pluggable command-line tool for managing the life cycle of data projects.

The Associated Press Data Team uses Datakit to auto-generate project skeletons, archive and share data on Amazon S3, and other routine tasks.

Datakit is a thin wrapper around the Cliff_ command-line framework and is intended for use with a growing ecosystem of plugins.

Feel free to use our plugins on Github_, or fork and modify them to suit your needs.

If you're comfortable programming in Python, you can create your own plugins (see :ref:creating-plugins).

Installation

For a system-wide install, from the command line::

$ sudo pip install datakit-core

Usage

After installing one or more plugins, Datakit can be used to invoke the commands provided by those plugins.

To see which commands plugins provide, try the --help flag::

$ datakit --help

Example: datakit-project

Install datakit-project::

    $ pip install datakit-project

The plugin provides a ``project create`` command. You need to specify a Cookiecutter_ template to use this command, for example the AP's R template:

.. image:: http://data.ap.org/projects/2019/datakit-docs/img/2.gif

That's the basic recipe for working with plugins: install, explore, and invoke! [1]_

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. [1] Plugins may also provide more robust docs, so don't forget to check those out when available.

.. _our plugins on Github: https://github.com/search?q=topic%3Adatakit-cli+org%3Aassociatedpress&type=Repositories
.. _Cliff: http://docs.openstack.org/developer/cliff/index.html
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _datakit-project: http://datakit-project.readthedocs.io/en/latest/
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage