Skip to content
Core library for the datakit CLI framework.
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
datakit Make the Help menu more human-friendly #8 Jan 27, 2018
docs Update docs to reflect new command syntax and misc packaging and stan… Jan 23, 2018
tests Make the Help menu more human-friendly #8 Jan 27, 2018
.editorconfig Iniital commit Jan 17, 2017
.gitignore Update docs to reflect new command syntax and misc packaging and stan… Jan 23, 2018
.travis.yml Only run travis builds against master Jan 23, 2018
AUTHORS.rst Iniital commit Jan 17, 2017
HISTORY.rst Make the Help menu more human-friendly #8 Jan 27, 2018
LICENSE Update copyright holder Feb 1, 2017
MANIFEST.in Iniital commit Jan 17, 2017
Makefile Update test command in Makefile Feb 1, 2017
README.rst Remove an extraneous gif for installation Jun 18, 2019
requirements-dev.txt Make the Help menu more human-friendly #8 Jan 27, 2018
requirements.txt
setup.cfg
setup.py Make the Help menu more human-friendly #8 Jan 27, 2018
tox.ini Make the Help menu more human-friendly #8 Jan 27, 2018

README.rst

Linux build status on Travis CI 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:

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.
You can’t perform that action at this time.