Skip to main content
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

Release files for catherder 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for catherder 0.1.1
File Size Uploaded
catherder-0.1.1.tar.gz 19.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for catherder 0.1.1
File Interpreter ABI Platform
catherder-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 39.9 kB

Release files / catherder-0.1.1.tar.gz

Download URL catherder-0.1.1.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
36e7dde1ac9cb1872d2dae01ea5e81aba64969b953d9b4693f5c0025afec5b1c
BLAKE2b-256 checksum
How to use checksums
2ec3381affd06527f5e4fc82c99731b07151442a96b1b51de2ee1b86db913127
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.9

Release files / catherder-0.1.1-py3-none-any.whl

Download URL catherder-0.1.1-py3-none-any.whl
Size 20.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
51cdf2ee569e833b7b3d988dd653cb7f4838b4c5e01dc449bcf47035285fdb2b
BLAKE2b-256 checksum
How to use checksums
28bc6eaf093406f331db74b461626d091b29805ee38630b5df0bf7f4f78435cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.9

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page