Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 4.55 KB

README.rst

File metadata and controls

145 lines (94 loc) · 4.55 KB
Raw

catherder

Latest PyPI version Latest Travis CI build status

A tool for syncing different project management tools.

Usage

The catherder methods can be accessed via the catherder command. Which can be call optionally with one or more project names. If a project name is not provided, the default project (as defined by the configuration file) will be assumed.

Print catherder command help (including options)
$ catherder -h
Configure one or more projects
$ catherder [project1 ...] --configure
Updating the caches of Github and Smartsheet data
$ catherder [project1 ...]
Updating the Github issues based on changes to the Smartsheet
$ catherder [project1 ...] --github
Updating the Smartsheet based on changes to the Github issues
$ catherder [project1 ...] --smartsheet
Sorting the project cards on the Github project board
$ catherder [project1 ...] --sort-project-cards
Updating the persons assigned to the Github issues
$ catherder [project1 ...] --assignees

Installation

Requirements

  • Python (>= 2.7)
  • PyGithub (installed automatically in instructions below)
  • smartsheet-python-sdk (installed automatically in instructions below)
  • A Github authentication token (see steps for creating one here)
  • A Smartsheet authentication token (see steps for creating one here)

Pre-Installation Steps

It is recommended, but not required, that you use anaconda to manage your Python environment in order to avoid issues with dependency conflicts.

  1. Download and run the miniconda installer for your operating system from here

  2. Create and activate a new conda environment with Python 3.6 and a name of your choosing from the terminal on Linux/OSX or Anaconda prompt on Windows:

    $ conda create -n <name> python=3.6
$ conda activate <name>

  3. Create a Github authentication token and save it to a secure location.

  4. Create a Smartsheets authenticaiton token and save it to a secure location.

Installation Steps

From PyPI

Enter the following command from your terminal prompt (or Anaconda promp on Windows).:

$ pip install catherder

From Source

  1. Clone the catherder repository.:

    $ git clone https://github.com/cropsinsilico/catherder.git

  2. Enter the local repository directory and install from source in development mode.:

    $ cd catherder
$ pip install -e .

From conda-forge

The package has not yet been uploaded to conda-forge.

Post-Installation Steps

After installation is complete, you can run the configuration to set up a project.:

$ catherder --configure

This will ask you to select a default project name and will ask you for information about the project that is required to complete the entry in the config file including your Github and Smartsheet authentication tokens and the names of the associated Github repository, Github project, and Smartsheet sheet.

Steps to Update

From PyPI

Enter the following command from your terminal prompt (or Anaconda prompt on Windows).:

$ pip install catherder -U

From Source

Enter the following command from your terminal prompt (or Anaconda prompt on Windows) from inside the cloned catherder repository.:

$ git pull

From conda-forge

The package has not yet been uploaded to conda-forge.

Licence

This software is free to use and resdistribute under the MIT license.

Authors

catherder was written by Meagan lang.

Todo

  • Fix bug where windows paths cause cache upload to root directory of repo
  • Make package general (e.g. 'Task Name' column coded in config file)
  • Create method for getting contacts from Smartsheet
  • Command for rolling back to a previous cache entry
  • Directions for deploying as heroku app