Repository files navigation

This Python package provides a Software Development Kit (SDK) for interacting with Mediumroast for GitHub. It is used internally by Mediumroast, Inc. and meant for developers to make use of.

The SDK is in active development and is subject to change. The SDK is not yet stable and should not be used in production environments.

To install the package, you can use pip:

pip install mediumroast_py

To use the package, you will need to import themediumroast_py modules and classes. The package provides three main classes for interacting with objects:Companies,Interactions, andUsers.

To use the package, you will need to authenticate with the Mediumroast API using theGitHubAuth class. Here is an example of how to authenticate with the Mediumroast API using a GitHub App installation and a private key file. You will need to set theMR_CLIENT_ID,MR_APP_ID, andYOUR_INSTALLATION_ID environment variables to the appropriate values for your GitHub App installation. You will also need to set theYOUR_PEM_FILE environment variable to the path of your private key file. Here is an example of how to authenticate with the Mediumroast API using a GitHub App installation and a private key file.

frommediumroast_py.apiimportCompanies,Interactions,Usersfrommediumroast_py.api.authorizeimportGitHubAuthauth=GitHubAuth(env={'clientId':os.getenv('MR_CLIENT_ID')})token=auth.get_access_token_pem(os.getenv('YOUR_PEM_FILE'),os.getenv('MR_APP_ID'),os.getenv('YOUR_INSTALLATION_ID'))

TheCompanies class provides methods for interacting with companies in Mediumroast. You can use theget_all method to get information about all companies.

company_ctl=Companies(token_info['token'],os.getenv('YOUR_ORG') ,process_name)companies=company_ctl.get_all()

TheInteractions class provides methods for interacting with interactions in Mediumroast. You can use theget_all method to get information about all interactions.

interaction_ctl=Interactions(token_info['token'],os.getenv('YOUR_ORG') ,process_name)interactions=interaction_ctl.get_all()

If you encounter any issues with the SDK, please report them on themediumroast_py issues page.