{"id":14979083,"url":"https://github.com/burakyilmaz321/pyheroicons","last_synced_at":"2025-10-28T14:30:46.295Z","repository":{"id":214376579,"uuid":"736284023","full_name":"burakyilmaz321/pyheroicons","owner":"burakyilmaz321","description":"Ready to use Tailwindcss Heroicons components for Python","archived":false,"fork":false,"pushed_at":"2024-12-03T21:26:30.000Z","size":433,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T15:22:12.735Z","etag":null,"topics":["component","django","fastapi","flask","heroicons","icon","python","svg","tailwind","tailwindcss","ui"],"latest_commit_sha":null,"homepage":"","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/burakyilmaz321.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":"2023-12-27T13:37:08.000Z","updated_at":"2024-12-30T22:10:49.000Z","dependencies_parsed_at":"2024-09-19T01:07:48.005Z","dependency_job_id":"f0b0eeb2-0a2c-4824-bb8a-14f3caa96c5d","html_url":"https://github.com/burakyilmaz321/pyheroicons","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"e622e043afbdd407741772aba270fd913c1667ae"},"previous_names":["burakyilmaz321/pyheroicons"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burakyilmaz321%2Fpyheroicons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burakyilmaz321%2Fpyheroicons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burakyilmaz321%2Fpyheroicons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/burakyilmaz321%2Fpyheroicons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/burakyilmaz321","download_url":"https://codeload.github.com/burakyilmaz321/pyheroicons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238662686,"owners_count":19509648,"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":["component","django","fastapi","flask","heroicons","icon","python","svg","tailwind","tailwindcss","ui"],"created_at":"2024-09-24T13:59:12.156Z","updated_at":"2025-10-28T14:30:45.621Z","avatar_url":"https://github.com/burakyilmaz321.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `pyheroicons`\n\n[![PyPI version](https://badge.fury.io/py/pyheroicons.svg)](https://pypi.org/project/pyheroicons)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python Versions](https://img.shields.io/pypi/pyversions/pyheroicons)](https://pypi.org/project/pyheroicons)\n[![Package Status](https://img.shields.io/pypi/status/pyheroicons)](https://pypi.org/project/pyheroicons)\n[![CI Build](https://github.com/burakyilmaz321/pyheroicons/actions/workflows/lint_and_test.yml/badge.svg)](https://github.com/burakyilmaz321/pyheroicons/actions/workflows/lint_and_test.yml)\n\n`pyheroicons` is a Python library that offers a convenient interface to the [Tailwind CSS Heroicons](https://heroicons.com/) icon set. This library allows developers to easily integrate Heroicons into Python-based web frameworks such as Django, Flask, or FastAPI by generating SVG icon template strings.\n\n## Installation\n\nTo install `pyheroicons`, simply use pip:\n\n```bash\npip install pyheroicons\n```\n\n## Usage\n\nImport `heroicon` function from `pyheroicons` and use it to generate icon templates:\n\n```python\nfrom pyheroicons import heroicon\n```\n\n## `heroicon` API\n\n- **name** The name of the Heroicon (e.g., \"academic-cap\").\n- **variant** The variant of the icon (\"outline\", \"solid\", \"mini\", or \"micro\").\n- **cls** Optional. A CSS class to apply to the SVG icon.\n- **strokewidth** Optional. The stroke width of the icon. \u003cins\u003eOnly applicable if the original SVG contains a stroke-width attribute. i.e. Only works for the \"outline\" variant.\u003c/ins\u003e\n\n## Example usage\n\n```python\nicon_svg = heroicon(name=\"academic-cap\", variant=\"outline\", cls=\"icon-class\", strokewidth=\"2\")\nprint(icon_svg)\n```\n\n## Keeping Up-to-Date\n\n`pyheroicons` aims to stay up-to-date with the Heroicons library. When a new version of Heroicons is released, `pyheroicons` will also release a corresponding version to ensure compatibility.\n\n| pyheroicons Version | Heroicons Version |\n| ------------------- | ----------------- |\n| 1.2.0               | 2.1.5             |\n\n## Contributing\n\nContributions to `pyheroicons` are welcomed!\n\n## License\n\n`pyheroicons` is released under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburakyilmaz321%2Fpyheroicons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fburakyilmaz321%2Fpyheroicons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fburakyilmaz321%2Fpyheroicons/lists"}