{"id":32558249,"url":"https://github.com/grv96/ghae","last_synced_at":"2025-10-28T23:54:42.298Z","repository":{"id":280503704,"uuid":"942219405","full_name":"GRV96/ghae","owner":"GRV96","description":"This library detects the responses to erroneous requests to the GitHub API. An exception signals these errors.","archived":false,"fork":false,"pushed_at":"2025-03-12T19:12:31.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-28T02:23:49.770Z","etag":null,"topics":["api","exception","exception-handling","github-api","githubapi","pypi","pypi-package","pypi-packages","python","python-exception-handling","python-exceptions","python-excpetion"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/ghae/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GRV96.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}},"created_at":"2025-03-03T19:06:28.000Z","updated_at":"2025-03-12T19:12:34.000Z","dependencies_parsed_at":"2025-03-03T22:00:28.124Z","dependency_job_id":null,"html_url":"https://github.com/GRV96/ghae","commit_stats":null,"previous_names":["grv96/ghae"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GRV96/ghae","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GRV96%2Fghae","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GRV96%2Fghae/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GRV96%2Fghae/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GRV96%2Fghae/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GRV96","download_url":"https://codeload.github.com/GRV96/ghae/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GRV96%2Fghae/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281533447,"owners_count":26517827,"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","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"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":["api","exception","exception-handling","github-api","githubapi","pypi","pypi-package","pypi-packages","python","python-exception-handling","python-exceptions","python-excpetion"],"created_at":"2025-10-28T23:54:00.155Z","updated_at":"2025-10-28T23:54:42.293Z","avatar_url":"https://github.com/GRV96.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ghae\n\n## FRANÇAIS\n\nCette bibliothèque détecte les réponses aux requêtes erronées à l'API de\nGitHub. Une exception signale ces erreurs.\n\n### Contenu\n\nL'exception `GitHubApiError` peut être levée quand une réponse de l'API de\nGitHub indique que la requête est erronée. Ses propriétés sont les suivantes.\n\n* `message`: le message d'erreur.\n* `doc_url`: l'URL de la documentation de l'erreur.\n* `status`: le code du statut de la réponse.\n* `req_url`: l'URL de la requête erronée.\n\nLa fonction `detect_github_api_error` examine les données provenant de l'API de\nGitHub et lève `GitHubApiError` si elles résultent d'une requête erronée. Les\ndonnées doivent être un objet produit par la lecture du contenu de la réponse,\nqui est en JSON.\n\nL'utilisateur devrait se fier à `detect_github_api_error` plutôt que lever\n`GitHubApiError` lui-même.\n\nPour plus d'informations, consultez la documentation et la démo dans le dépôt\nde code source.\n\n### Dépendances\n\nCette commande installe les dépendances nécessaires au développement de `ghae`.\n```\npip install -r requirements-dev.txt\n```\n\n### Démo\n\nLa démo montre comment déterminer qu'une requête à l'API de GitHub est erronée.\nElle constitue aussi un exemple de gestion de `GitHubApiError`.\n\nAffichez l'aide pour plus d'informations.\n```\npython demo.py -h\n```\n\nCet exemple envoie une requête valide.\n```\npython demo.py -r GRV96/ghae\n```\n\nCet exemple envoie une requête erronée.\n```\npython demo.py -r GRV96/gha\n```\n\n### Tests automatiques\n\nCette commande exécute les tests automatiques.\n```\npytest tests\n```\n\n## ENGLISH\n\nThis library detects the responses to erroneous requests to the GitHub API. An\nexception signals these errors.\n\n### Content\n\nException `GitHubApiError` can be raised when a response from the GitHub API\nindicates that the request is erroneous. Its properties are the following.\n\n* `message`: the error message.\n* `doc_url`: the URL to the error's documentation.\n* `status`: the response's status code.\n* `req_url`: the erroneous request's URL.\n\nFunction `detect_github_api_error` examines data from the GitHub API and raises\na `GitHubApiError` if it is the result of an erroneous request. The data must\nbe an object returned by the parsing of the response's content, which is in\nJSON.\n\nThe user should rely on `detect_github_api_error` rather than raising\n`GitHubApiError` themself.\n\nFor more information, consult the documentation and the demo in the source code\nrepository.\n\n### Dependencies\n\nThis command installs the dependencies required for the development of `ghae`.\n```\npip install -r requirements-dev.txt\n```\n\n### Demo\n\nThe demo shows how to find out whether a request to the GitHub API is\nerroneous. It also constitutes an example of handling a `GitHubApiError`.\n\nDisplay the help message for more information.\n```\npython demo.py -h\n```\n\nThis example sends a valid request.\n```\npython demo.py -r GRV96/ghae\n```\n\nThis example sends an erroneous request.\n```\npython demo.py -r GRV96/gha\n```\n\n### Automated Tests\n\nThis command executes the automated tests.\n```\npytest tests\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrv96%2Fghae","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrv96%2Fghae","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrv96%2Fghae/lists"}