{"id":34017558,"url":"https://github.com/mediumroast/mediumroast_py","last_synced_at":"2026-04-06T02:01:30.211Z","repository":{"id":37047259,"uuid":"502425879","full_name":"mediumroast/mediumroast_py","owner":"mediumroast","description":"Mediumroast for GitHub API/SDK","archived":false,"fork":false,"pushed_at":"2025-06-25T00:55:05.000Z","size":54982,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-15T03:14:18.273Z","etag":null,"topics":["competition","competitive-insights","customer","customer-insights","mediumroast","requirements","requirements-management","voice-of-the-customer"],"latest_commit_sha":null,"homepage":"https://www.mediumroast.io/product.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mediumroast.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-06-11T18:25:58.000Z","updated_at":"2025-06-04T13:06:04.000Z","dependencies_parsed_at":"2024-05-22T13:43:24.508Z","dependency_job_id":"d55b9c49-bfbc-420f-a57d-9c5e3d0b081f","html_url":"https://github.com/mediumroast/mediumroast_py","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.048387096774193505","last_synced_commit":"3e5cd6b1016fa132b35a0352a9c3ba7b2f3f147c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mediumroast/mediumroast_py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mediumroast%2Fmediumroast_py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mediumroast%2Fmediumroast_py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mediumroast%2Fmediumroast_py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mediumroast%2Fmediumroast_py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mediumroast","download_url":"https://codeload.github.com/mediumroast/mediumroast_py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mediumroast%2Fmediumroast_py/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31456664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"online","status_checked_at":"2026-04-06T02:00:07.287Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["competition","competitive-insights","customer","customer-insights","mediumroast","requirements","requirements-management","voice-of-the-customer"],"created_at":"2025-12-13T14:41:01.541Z","updated_at":"2026-04-06T02:01:30.206Z","avatar_url":"https://github.com/mediumroast.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmediumroast%2Fmediumroast_py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmediumroast%2Fmediumroast_py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmediumroast%2Fmediumroast_py/lists"}