# mediumroast_py
## Introduction
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.
### Notice
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.
## Installation
To install the package, you can use pip:
```bash
pip install mediumroast_py
```
## Usage
To use the package, you will need to import the `mediumroast_py` modules and classes. The package provides three main classes for interacting with objects: `Companies`, `Interactions`, and `Users`.
### Authentication
To use the package, you will need to authenticate with the Mediumroast API using the `GitHubAuth` 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 the `MR_CLIENT_ID`, `MR_APP_ID`, and `YOUR_INSTALLATION_ID` environment variables to the appropriate values for your GitHub App installation. You will also need to set the `YOUR_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.
```python
from mediumroast_py.api import Companies, Interactions, Users
from mediumroast_py.api.authorize import GitHubAuth
auth = 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')
)
```
### Companies
The `Companies` class provides methods for interacting with companies in Mediumroast. You can use the `get_all` method to get information about all companies.
```python
company_ctl = Companies(token_info['token'], os.getenv('YOUR_ORG') , process_name)
companies = company_ctl.get_all()
```
### Interactions
The `Interactions` class provides methods for interacting with interactions in Mediumroast. You can use the `get_all` method to get information about all interactions.
```python
interaction_ctl = Interactions(token_info['token'], os.getenv('YOUR_ORG') , process_name)
interactions = interaction_ctl.get_all()
```
## Issues
If you encounter any issues with the SDK, please report them on the [mediumroast_py issues](https://github.com/mediumroast/mediumroast_py/issues) page.
Raw data
{
"_id": null,
"home_page": "https://github.com/mediumroast/mediumroast_py",
"name": "mediumroast-py",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Product Management, Competitive Insights, Customer Insights, Partner Insights, Empowered Teams",
"author": "Michael Hay",
"author_email": "michael.hay@mediumroast.io",
"download_url": "https://files.pythonhosted.org/packages/0a/c4/81aec32d84a7ebab81c1ce0dfde957a05277a232060e5ce19c83c6b4c1ed/mediumroast_py-0.6.14.1.tar.gz",
"platform": null,
"description": "# mediumroast_py\n\n## Introduction\n\nThis 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.\n\n### Notice\nThe SDK is in active development and is subject to change. The SDK is not yet stable and should not be used in production environments. \n\n## Installation\n\nTo install the package, you can use pip:\n\n```bash\npip install mediumroast_py\n```\n\n## Usage\nTo use the package, you will need to import the `mediumroast_py` modules and classes. The package provides three main classes for interacting with objects: `Companies`, `Interactions`, and `Users`.\n\n### Authentication\nTo use the package, you will need to authenticate with the Mediumroast API using the `GitHubAuth` 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 the `MR_CLIENT_ID`, `MR_APP_ID`, and `YOUR_INSTALLATION_ID` environment variables to the appropriate values for your GitHub App installation. You will also need to set the `YOUR_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.\n\n```python\nfrom mediumroast_py.api import Companies, Interactions, Users\nfrom mediumroast_py.api.authorize import GitHubAuth\n\nauth = GitHubAuth(env={'clientId': os.getenv('MR_CLIENT_ID')})\ntoken = auth.get_access_token_pem(\n os.getenv('YOUR_PEM_FILE'), \n os.getenv('MR_APP_ID'), \n os.getenv('YOUR_INSTALLATION_ID')\n)\n```\n\n### Companies\nThe `Companies` class provides methods for interacting with companies in Mediumroast. You can use the `get_all` method to get information about all companies.\n\n```python\ncompany_ctl = Companies(token_info['token'], os.getenv('YOUR_ORG') , process_name)\ncompanies = company_ctl.get_all()\n```\n\n### Interactions\nThe `Interactions` class provides methods for interacting with interactions in Mediumroast. You can use the `get_all` method to get information about all interactions.\n\n```python\ninteraction_ctl = Interactions(token_info['token'], os.getenv('YOUR_ORG') , process_name)\ninteractions = interaction_ctl.get_all()\n```\n\n## Issues\nIf you encounter any issues with the SDK, please report them on the [mediumroast_py issues](https://github.com/mediumroast/mediumroast_py/issues) page.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "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.",
"version": "0.6.14.1",
"project_urls": {
"Bug Tracker": "https://github.com/mediumroast/mediumroast_py/issues",
"Homepage": "https://github.com/mediumroast/mediumroast_py",
"Repository": "https://github.com/mediumroast/mediumroast_py"
},
"split_keywords": [
"product management",
" competitive insights",
" customer insights",
" partner insights",
" empowered teams"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26c6b6da5e9214e5deb3c1fa3c317f0a117b3cd5e5610f4041fb4bd2b6266d46",
"md5": "5c28e0e9b69f0ca7121b3f758424fb94",
"sha256": "2dfc032d78431fd89974c2bd2c5aac545af60a382c6ac039993d2b3ba4f53d4e"
},
"downloads": -1,
"filename": "mediumroast_py-0.6.14.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c28e0e9b69f0ca7121b3f758424fb94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 21222,
"upload_time": "2024-11-17T04:52:23",
"upload_time_iso_8601": "2024-11-17T04:52:23.315139Z",
"url": "https://files.pythonhosted.org/packages/26/c6/b6da5e9214e5deb3c1fa3c317f0a117b3cd5e5610f4041fb4bd2b6266d46/mediumroast_py-0.6.14.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ac481aec32d84a7ebab81c1ce0dfde957a05277a232060e5ce19c83c6b4c1ed",
"md5": "ece8fc55decc9817d518778ee21a4fe2",
"sha256": "9c3eecf9b2e7e9e5ef6b059cdd34a115dc04aa29a6d250970574f983a47d91fe"
},
"downloads": -1,
"filename": "mediumroast_py-0.6.14.1.tar.gz",
"has_sig": false,
"md5_digest": "ece8fc55decc9817d518778ee21a4fe2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 19948,
"upload_time": "2024-11-17T04:52:25",
"upload_time_iso_8601": "2024-11-17T04:52:25.071962Z",
"url": "https://files.pythonhosted.org/packages/0a/c4/81aec32d84a7ebab81c1ce0dfde957a05277a232060e5ce19c83c6b4c1ed/mediumroast_py-0.6.14.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 04:52:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mediumroast",
"github_project": "mediumroast_py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mediumroast-py"
}
JSON
