{"id":15659722,"url":"https://github.com/capjamesg/indieweb-utils","last_synced_at":"2025-08-20T16:32:29.373Z","repository":{"id":38310876,"uuid":"435998331","full_name":"capjamesg/indieweb-utils","owner":"capjamesg","description":"Utilities to aid the implementation of various IndieWeb specifications and functionalities. Built with Python. ","archived":false,"fork":false,"pushed_at":"2024-07-12T22:48:31.000Z","size":715,"stargazers_count":23,"open_issues_count":5,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-10T03:32:13.078Z","etag":null,"topics":["indieweb","python"],"latest_commit_sha":null,"homepage":"https://indieweb-utils.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/capjamesg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-07T19:12:25.000Z","updated_at":"2024-11-05T23:56:28.000Z","dependencies_parsed_at":"2023-01-25T19:31:53.606Z","dependency_job_id":"2c94c3bf-6af8-4089-9850-205b799e084f","html_url":"https://github.com/capjamesg/indieweb-utils","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":"readthedocs/tutorial-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Findieweb-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Findieweb-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Findieweb-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capjamesg%2Findieweb-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capjamesg","download_url":"https://codeload.github.com/capjamesg/indieweb-utils/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230438185,"owners_count":18225870,"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":["indieweb","python"],"created_at":"2024-10-03T13:18:22.257Z","updated_at":"2024-12-19T13:08:10.916Z","avatar_url":"https://github.com/capjamesg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python indieweb-utils Library\n\n[![Documentation Status](https://readthedocs.org/projects/indieweb-utils/badge/?version=latest)](https://indieweb-utils.readthedocs.io/en/latest/?badge=latest)\n[![image](https://badge.fury.io/py/indieweb-utils.svg)](https://badge.fury.io/py/indieweb-utils)\n[![image](https://img.shields.io/pypi/dm/indieweb-utils)](https://pypistats.org/packages/indieweb-utils)\n[![image](https://img.shields.io/pypi/l/indieweb-utils)](https://github.com/capjamesg/indieweb-utils/blob/main/LICENSE)\n[![image](https://img.shields.io/pypi/pyversions/indieweb-utils)](https://badge.fury.io/py/indieweb-utils)\n\n**indieweb-utils** provides building blocks for people implementing IndieWeb applications in Python. Discover IndieWeb endpoints, find feeds on a page, infer page names, generate reply contexts, and more!\n\nThe documentation for this project is available at [indieweb-utils.readthedocs.io](https://indieweb-utils.readthedocs.io/en/latest/).\n\n## Installation 💻\n\nTo get started, pip install `indieweb-utils`:\n\n    pip install indieweb-utils\n\n## Quickstart ⚡\n\nHere are a few quick code snippets for actions enabled by IndieWeb Utils.\n\n### get reply context about a URL\n\n``` python\nimport indieweb_utils\n\ncontext = indieweb_utils.get_reply_context(\n    url=\"https://jamesg.blog\",\n    summary_word_limit=50\n)\n\nprint(context.name) # \"Home | James' Coffee Blog\"\n```\n\n### Remove tracking parameters from a URL\n\n``` python\nimport indieweb_utils\n\nurl = \"https://jamesg.blog/indieweb/?utm_source=twitter\u0026utm_medium=social\u0026utm_campaign=webmention\"\n\nurl_without_tracking = indieweb_utils.remove_tracking_params(url)\n\nprint(url_without_tracking) # https://jamesg.blog/indieweb/\n```\n\n### Create a paginator for a series\n\n``` python\nimport indieweb_utils\n\npages = indieweb_utils.Paginator([\"post1\", \"post2\", ...], 1)\n\nprint(pages.next_page()) [[\"post1\"]]\n```\n\n## License 👩‍⚖️\n\nThe code in this project is licensed under the [Zero-Clause BSD\nLicense](LICENSE.md).\n\nThe documentation in this project is licensed under a [CC BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).\n\n## Running Tests 🧪\n\nQuality is maintained ensuring each merged passes testing, typing, linting, and formatting requirements.\n\nTo check locally install the development dependencies and run the suite using [tox]{.title-ref}.\n\n    $ pip install -r requirements_dev.txt\n    $ tox\n\nAlternatively, you can run just a single check by passing the environment to tox.\n\n### Unit Tests\n\nTests use pytest.\n\n    $ tox -e py39  # Run all tests\n    $ tox -e py39 tests/test_indieweb_utils.py::TestPostTypeDiscovery  # Run a single test\n\n### Linting\n\nLinting is checked with black, isort, and flake8.\n\n    $ tox -e lint\n\nBlack and isort errors can be fixed automatically. Use fmt to fix those errors automatically.\n\n    $ tox -e fmt\n\n### Typing\n\nTypes are validated with mypy.\n\n    $ tox -e typecheck\n\n## Contributing 🛠️\n\nThis project welcomes contributions from anyone who wants to improve the\nlibrary.\n\nPlease see the [contributing guidelines](CONTRIBUTING.md) for more\ninformation on how to contribute to the repository.\n\n## Contributors 💻\n\n-   [capjamesg](https://github.com/capjamesg)\n-   [tantek](https://github.com/tantek)\n-   [jamesvandyne](https://github.com/jamesvandyne)\n-   [angelogladding](https://github.com/angelogladding)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapjamesg%2Findieweb-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapjamesg%2Findieweb-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapjamesg%2Findieweb-utils/lists"}