{"id":26927554,"url":"https://github.com/lmmx/igloosphinx","last_synced_at":"2025-06-10T19:13:53.905Z","repository":{"id":276555583,"uuid":"929589109","full_name":"lmmx/igloosphinx","owner":"lmmx","description":"Accessing Intersphinx inventories for Python packages using PyPI metadata to locate documentation sites","archived":false,"fork":false,"pushed_at":"2025-05-19T18:17:56.000Z","size":129,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-19T19:31:47.923Z","etag":null,"topics":["intersphinx","polars"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/igloosphinx","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/lmmx.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":"2025-02-08T22:30:03.000Z","updated_at":"2025-05-19T18:17:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"99932606-acec-4f16-b989-e9395c01a3d5","html_url":"https://github.com/lmmx/igloosphinx","commit_stats":null,"previous_names":["lmmx/igloosphinx"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmmx%2Figloosphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmmx%2Figloosphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmmx%2Figloosphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmmx%2Figloosphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lmmx","download_url":"https://codeload.github.com/lmmx/igloosphinx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmmx%2Figloosphinx/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259133000,"owners_count":22810513,"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":["intersphinx","polars"],"created_at":"2025-04-02T04:16:40.177Z","updated_at":"2025-06-10T19:13:53.876Z","avatar_url":"https://github.com/lmmx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# igloosphinx\n\n**Accessing Intersphinx inventories for Python packages using PyPI metadata to locate documentation sites.**\n\n`igloosphinx` provides a command-line interface and library access to Intersphinx inventories, enabling users to easily find and retrieve documentation for Python packages. The tool works by:\n\n- Performing a PyPI metadata lookup to identify the documentation site for a given package.\n- Making educated guesses about the location of the `objects.inv` file.\n- Allowing users to review version changes and access relevant documentation seamlessly.\n\n## Features\n\n- **PyPI Metadata Lookup**: Automatically fetches the documentation URL from PyPI.\n- **Intersphinx Inventory Retrieval**: Accesses and retrieves the `objects.inv` file for easy linking to documentation.\n- **Version Change Review**: Provides functionality to review changes between different versions of the documentation.\n\n## Installation\n\n```bash\npip install igloosphinx[polars]\n```\n\nOn older CPUs run:\n\n```python\npip install igloosphinx[polars-lts-cpu]\n```\n\n## Usage\n\n```python\nfrom igloosphinx import Inventory\n\n# Create an Intersphinx instance for a specific package\nintersphinx = Inventory(package_name=\"example-package\")\n\n# Fetch the documentation inventory\ninventory = intersphinx.fetch_inventory()\n\n# Review version changes\nchanges = intersphinx.review_version_changes()\n```\n\n## Contributing\n\n1. **Issues \u0026 Discussions**: Please open a GitHub issue for bugs, feature requests, or questions.\n2. **Pull Requests**: PRs are welcome! Add tests under `tests/`, update the docs, and ensure you run `pytest` locally.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmmx%2Figloosphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flmmx%2Figloosphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmmx%2Figloosphinx/lists"}