{"id":14986486,"url":"https://github.com/bleemeo/bleemeo-python","last_synced_at":"2025-07-07T05:07:21.531Z","repository":{"id":248140517,"uuid":"827842452","full_name":"bleemeo/bleemeo-python","owner":"bleemeo","description":"Bleemeo Python SDK","archived":false,"fork":false,"pushed_at":"2025-06-23T13:08:59.000Z","size":90,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-23T13:16:14.331Z","etag":null,"topics":["bleemeo","bleemeo-api","monitoring","openapi","python"],"latest_commit_sha":null,"homepage":"","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/bleemeo.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}},"created_at":"2024-07-12T13:49:46.000Z","updated_at":"2025-06-23T13:06:54.000Z","dependencies_parsed_at":"2024-10-13T23:40:42.161Z","dependency_job_id":"b0f77993-2af6-443d-ab09-a331bc92ed4b","html_url":"https://github.com/bleemeo/bleemeo-python","commit_stats":{"total_commits":44,"total_committers":3,"mean_commits":"14.666666666666666","dds":"0.11363636363636365","last_synced_commit":"a262d54d5723a68eacf16ffb0829eef0b7a1023b"},"previous_names":["bleemeo/bleemeo-python"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/bleemeo/bleemeo-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bleemeo%2Fbleemeo-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bleemeo%2Fbleemeo-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bleemeo%2Fbleemeo-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bleemeo%2Fbleemeo-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bleemeo","download_url":"https://codeload.github.com/bleemeo/bleemeo-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bleemeo%2Fbleemeo-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264016741,"owners_count":23544627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bleemeo","bleemeo-api","monitoring","openapi","python"],"created_at":"2024-09-24T14:12:56.847Z","updated_at":"2025-07-07T05:07:21.514Z","avatar_url":"https://github.com/bleemeo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bleemeo Python [![Python 3.8 at least](https://img.shields.io/badge/python-%3E%3D3.8-blue.svg?style=flat\u0026logo=python\u0026logoColor=white)](https://www.python.org/downloads/release/python-380/) [![GitHub License](https://img.shields.io/github/license/bleemeo/bleemeo-python)](https://github.com/bleemeo/bleemeo-python/blob/main/LICENSE)\n\nPython library for interacting with the Bleemeo API\n\n## Requirements\n\n- Python3.8 or later\n- An account on [Bleemeo](https://bleemeo.com/)\n\n## Installation\n\nTake a look at [venv](https://docs.python.org/3/tutorial/venv.html).\nThis tool provides isolated Python environments, which are more practical than installing packages system-wide.\n\nAfter you’ve created and activated a virtual environment, run the command:\n\n```shell\npython -m pip install --upgrade bleemeo\n```\n\n## Documentation\n\nThe Python library is documented using docstring\nin [the source code](https://github.com/bleemeo/bleemeo-python/bleemeo).\n\nSome examples of library usage can be found in [examples](./examples).\n\n## Basic usage\n\nListing the first 10 agents of your account:\n\n```python\nfrom bleemeo import Client, Resource, APIError\n\n\ndef list_agents():\n    with Client(load_from_env=True) as client:\n        try:\n            resp_page = client.get_page(Resource.AGENT, page=1, page_size=10,\n                                        params={\"active\": True, \"fields\": \"id,fqdn,display_name\"})\n            for agent in resp_page.json()[\"results\"]:\n                print(f\"* Agent {agent['display_name']} (fqdn = {agent['fqdn']}, id = {agent['id']})\")\n        except APIError as e:\n            print(f\"API error: {e}:\\n{e.response.text}\")\n\n\nif __name__ == '__main__':\n    list_agents()\n```\n\nSave this file as list_agents.py.\n\nRun it with:\n\n```shell\nBLEEMEO_USER=user-email@domain.com BLEEMEO_PASSWORD=password python3 list_agents.py\n```\n\n\u003e More examples can be found in [examples](./examples)\n\nTo run an example from a clone of this repository, run the following:\n\n```shell\nBLEEMEO_USER=user-email@domain.com BLEEMEO_PASSWORD=password python3 examples/list_metrics.py\n```\n\n## Environment\n\nAt least the following options should be configured (as environment variables or with options):\n\n- Credentials OR initial refresh token\n- All other configuration options are optional and could be omitted\n\n\u003e Ways to provide those options are referenced in the [Configuration](#configuration) section.\n\n## Configuration\n\n**For environment variables to be taken into account, the parameter `load_from_env` of the `Client` constructor must be\nset to `True`.**\n\n| Property                      | Constructor parameter(s)                  | Env variable(s)                                           | Default values                                                       |\n|-------------------------------|-------------------------------------------|-----------------------------------------------------------|----------------------------------------------------------------------|\n| Credentials                   | `username` \u0026 `password`                   | `BLEEMEO_USER` \u0026 `BLEEMEO_PASSWORD`                       | None. This option is required (unless initial refresh token is used) |\n| Bleemeo account header        | `account_id`                              | `BLEEMEO_ACCOUNT_ID`                                      | The first account associated with used credentials.                  |\n| OAuth client ID/secret        | `oauth_client_id` \u0026 `oauth_client_secret` | `BLEEMEO_OAUTH_CLIENT_ID` \u0026 `BLEEMEO_OAUTH_CLIENT_SECRET` | The default SDK OAuth client ID                                      |\n| API URL                       | `api_url`                                 | `BLEEMEO_API_URL`                                         | `https://api.bleemeo.com`                                            |\n| Initial refresh token         | `oauth_initial_refresh_token`             | `BLEEMEO_OAUTH_INITIAL_REFRESH_TOKEN`                     | None. This is an alternative to username \u0026 password credentials.     |\n| Custom headers                | `custom_headers`                          | -                                                         | `{\"User-Agent\": \"Bleemeo Python Client\"}`                            |\n| Throttle max auto retry delay | `throttle_max_auto_retry_delay`           | -                                                         | 1 minute.                                                            |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbleemeo%2Fbleemeo-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbleemeo%2Fbleemeo-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbleemeo%2Fbleemeo-python/lists"}