Skip to main content

API client for PathGather

Project description

PathGather Documentation Status Updates Python 3

The Pathgather python package is for connecting to and leveraging the Pathgather REST API from Python 2 or 3.

This project is not part of Pathgather or operated by Pathgather, it is an open-source package for consuming their API.


from pathgather import PathgatherClient
import yaml
import json
from pprint import pprint

with open('.tenant.yml', 'r') as tenant_yml:
   config = yaml.load(tenant_yml)

client = PathgatherClient(config['host'], config['api_key'])


with open('dump.json', 'r') as dump_j:
    data = json.load(dump_j)

for user in data['users']:
    print('Creating {0}'.format(user['full_name']))
    new_user = client.users.create(
        department='Learning and Development',





  • User management

  • Content management

  • Path queries

  • User completions of content

  • Gathering management and gathering membership

  • Gathering Content and Path management

  • Skills

  • Creating and listing comments on paths and content items


The following features are in the API but not yet in this client

  • Conversations


This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.



  • Fix bug when department isn’t set for a user and paging all users (even deactivated ones)


  • Fix bug in deactivating content.


  • Fix the feature to add content to a gathering.


  • Add providers API


  • Set default of 50 max results per page, configurable via client object.


  • Added support for comments on paths, creating and listing comments. Delete comment added but API returns 404.

  • Added support for comments on content


  • Allow filtering of paths and users by custom query

  • Added get_by_email to users class


  • Use arrow dates on formatted UserPath

1.4.0 (2018-03-12)

  • Add support for filtering content

  • Add support for updating a piece of content

1.3.0 (2017-12-11)

  • Add pathgather.skills API for gathering, listing and adding skills

  • Add support to invite a user from a gathering

  • Remove add_user feature, since the API doesn’t work

  • Add ability to list content in a gathering and delete content

  • Add support to list paths within a gathering

  • Update production path and user models

1.2.0 (2017-12-09)

  • Fetch content completions and starts for users

  • Register content completion for a user and a piece of content

  • Fetch path starts and completions for users

  • Gatherings API for listing, getting, creating, updating and deleting Gatherings

  • List users within a gathering

  • Add or remove users from a gathering

1.1.0 (2017-12-08)

  • Updated content models with new fields

  • Added support to specific content provider by name or custom_id

  • Fixed doc issue with content.create

  • Added pathgather.models package to

  • Added SSL check disable flag on client and HTTP proxy settings

1.0.0 (2017-09-01)

  • Introduce models for all methods, created tests based on documented and real API results. 91% test coverage

  • Add support for adding skills to users, setting the skill level and deleting skills

0.5.0 (2017-09-01)

  • Added some unit tests to the base client and improved doc strings for documentation

0.4.0 (2017-08-29)

  • [FIX] Remove default proxy settings

  • Add support to page out all() methods in content, users and paths. Method will now return all results

0.3.0 (2017-08-29)

  • Add proxy support

0.2.0 (2017-08-28)

  • Added path and content API endpoints

0.1.0 (2017-08-28)

  • First release on PyPI.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pathgather-1.15.0.tar.gz (50.1 kB view hashes)

Uploaded source

Built Distribution

pathgather-1.15.0-py2.py3-none-any.whl (28.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page