Skip to content
Datakit plugin to help manage Github integration on data projects.
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.
.github
datakit_github
docs
tests
.editorconfig Initial commit Jul 26, 2019
.gitignore
.readthedocs.yml
.travis.yml Initial commit Jul 26, 2019
AUTHORS.rst
CONTRIBUTING.rst Initial commit Jul 26, 2019
HISTORY.rst
LICENSE Initial commit Jul 26, 2019
MANIFEST.in
Makefile
README.rst
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
tox.ini

README.rst

Documentation Status

DataKit GitHub plugin

Overview

This plugin provides light-weight GitHub integration for the DataKit command-line tool. It's designed to streamline the process of generating a GitHub project and linking it to a local directory containing a newly created project skeleton. It's intended to be used in tandem with the datakit-project plugin, which helps generate project skeletons for data work and software development.

Features

The plugin provides the following features:

  • Interactive selection of GitHub account for project creation
  • Automated creation of a GitHub project
  • Ability to set privacy level of repo
  • Automated execution of git commands to bootstrap a project (init/add/commit)
  • Linking of local Git repository to newly created GitHub project
  • Automated "push" of initial commit to new GitHub project

In action

Once datakit-github is installed, it becomes a cinch to "gitify" newly created projects and integrate them with GitHub:

# After generating an initial project structure...
cd my-awesome-project

# ...you can transform the project into a git repo
# and integrate with GitHub with a single command
datakit github integrate

Note

Check out the :ref:`install` and :ref:`usage` docs for more details.

You can’t perform that action at this time.