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.

• Documentation: http://datakit-github.readthedocs.io/en/latest/
• GitHub: https://github.com/associatedpress/datakit-github
• PyPI: https://pypi.python.org/pypi/datakit-github
• Free and open source software: ISC license

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 Installation and Usage docs for more details.

Documentation

• Installation
  • Preliminary Git and GitHub setup
  • Install DataKit libraries
  • Generate GitHub API token
  • Add API token to config
• Usage
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
• Credits
  • Development Lead
  • Contributors
• History
  • 0.1.2 (2022-01-18)
  • 0.1.1 (2019-12-31)
  • 0.1.0 (2019-10-04)

Indices and tables

• Index
• Module Index
• Search Page

Credits

This plugin was created with Cookiecutter and the associatedpress/cookiecutter-datakit-plugin project template (a modified version of the most excellent audreyr/cookiecutter-pypackage).