Skip to content

README.md

Latest commit

 

History

History
50 lines (38 loc) · 1.4 KB

README.md

File metadata and controls

50 lines (38 loc) · 1.4 KB

Journify Python SDK

The official python client for Journify — The hassle-free way to integrate Journify into any Python application.

Installation

pip install journify-python-sdk

Usage

import journify as journify

def on_journify_error(error, items):
    print("A Journify error occurred:", error)

journify.debug = True
journify.on_error = on_journify_error
journify.write_key = '<YOUR_WRITE_KEY>'

journify.identify('user-123-id', {
    'email': '[email protected]',
    'name': 'John Smith',
})

journify.track('user-123-id', 'Python event', {
  'plan': 'Enterprise'
})

journify.page('user-123-id', 'Page category', 'Page name', {
  'url': 'http://journify.io'
})

journify.group('user-123-id', 'group-123-id', {
  'name': 'Initech',
  'domain': 'Accounting Software'
})

Documentation

Documentation is available at https://docs.journify.io/sources/python.

Contributing

You can contribute to Journify Python SDK by forking the repo and making pull requests on the master branch.

To publish a new version, you need to add a prefix to your pull request title following the semantic versioning spec:

  • [MAJOR] {Pull request title}
  • [MINOR] {Pull request title}
  • [PATCH] {Pull request title}

Once your PR is merged and the CI pipeline is passed, your code will be published to npm.