py-phosphor-icons 0.1.0__tar.gz

py_phosphor_icons-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - run: uv python install ${{ matrix.python-version }}
+
+      - run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+      - name: Test
+        run: uv run pytest

py_phosphor_icons-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - run: uv build
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

py_phosphor_icons-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag to release (e.g. v0.0.1)"
+        required: true
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get Phosphor version
+        id: phosphor
+        run: echo "version=$(cat src/py_phosphor_icons/phosphor_version.txt)" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          TAG=${{ github.ref_name != 'master' && github.ref_name || inputs.tag }}
+          gh release create "$TAG" \
+            --title "$TAG" \
+            --draft \
+            --notes "Synced with [Phosphor Icons ${{ steps.phosphor.outputs.version }}](https://github.com/phosphor-icons/homepage/releases/tag/${{ steps.phosphor.outputs.version }})."

py_phosphor_icons-0.1.0/.github/workflows/update-icons.yml

@@ -0,0 +1,64 @@
+name: Update Icons
+
+on:
+  schedule:
+    - cron: "0 9 * * 1" # Every Monday at 9:00 UTC
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.RELEASE_TOKEN_DJC_PHOSPHOR_ICONS }}
+
+      - uses: astral-sh/setup-uv@v6
+
+      - run: uv sync
+
+      - name: Check for new icons
+        id: check
+        run: uv run python scripts/check_new_icons.py
+
+      - name: Download updated icons
+        if: steps.check.outputs.has_new == 'true'
+        run: uv run python scripts/download_icons.py ${{ steps.check.outputs.new_version }}
+
+      - name: Regenerate preview
+        if: steps.check.outputs.has_new == 'true'
+        run: uv run python scripts/preview_icons.py
+
+      # Always: tags and categories are edited upstream between icon releases.
+      - name: Download metadata
+        run: uv run python scripts/download_metadata.py
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet -- src/ docs/ README.md; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Bump version
+        id: version
+        if: steps.changes.outputs.changed == 'true'
+        run: |
+          uv version --bump patch
+          echo "new_version=$(uv version --short)" >> $GITHUB_OUTPUT
+
+      - name: Commit and tag
+        if: steps.changes.outputs.changed == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add src/py_phosphor_icons/svgs/ src/py_phosphor_icons/search/metadata.json src/py_phosphor_icons/phosphor_version.txt pyproject.toml uv.lock README.md docs/preview.html
+          git commit -m "chore: sync with phosphor $(cat src/py_phosphor_icons/phosphor_version.txt)"
+          git tag "v${{ steps.version.outputs.new_version }}"
+          git push && git push --tags

py_phosphor_icons-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/

py_phosphor_icons-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: py-phosphor-icons
+Version: 0.1.0
+Summary: Phosphor Icons for Python: the SVGs, a loader, and search over them
+Author-email: Joey Jurjens <joeyjurjens@gmail.com>
+Keywords: icons,phosphor,svg
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# py-phosphor-icons
+
+[Phosphor Icons](https://phosphoricons.com/) for Python: the SVGs themselves, a
+loader, and search over the icon metadata. No framework, no dependencies.
+
+Framework integrations build on this package:
+
+- [djc-phosphor-icons](https://github.com/joeyjurjens/djc-phosphor-icons) for django-components
+- [citry-phosphor-icons](https://github.com/joeyjurjens/citry-phosphor-icons) for citry
+
+## Install
+
+```bash
+pip install py-phosphor-icons
+```
+
+## Use
+
+```python
+from py_phosphor_icons import get_svg, get_svg_inner, search_icons
+
+get_svg("house")  # the whole <svg> element
+get_svg_inner("house", "bold")  # just its contents
+search_icons("home")  # ranked IconEntry results
+```
+
+Weights are `thin`, `light`, `regular`, `bold`, `fill` and `duotone`; styles are
+`flat` and `stroke`. An unknown name raises `FileNotFoundError` with the closest
+matches suggested.
+
+## Ranking
+
+Search scoring is pluggable. Pass one per call, or set it for the process:
+
+```python
+from py_phosphor_icons import Ranking, search_icons, set_ranking
+
+search_icons("home", ranking=MyRanking())
+set_ranking("myapp.ranking.MyRanking")  # a class or a dotted path
+```

py_phosphor_icons-0.1.0/README.md

@@ -0,0 +1,40 @@
+# py-phosphor-icons
+
+[Phosphor Icons](https://phosphoricons.com/) for Python: the SVGs themselves, a
+loader, and search over the icon metadata. No framework, no dependencies.
+
+Framework integrations build on this package:
+
+- [djc-phosphor-icons](https://github.com/joeyjurjens/djc-phosphor-icons) for django-components
+- [citry-phosphor-icons](https://github.com/joeyjurjens/citry-phosphor-icons) for citry
+
+## Install
+
+```bash
+pip install py-phosphor-icons
+```
+
+## Use
+
+```python
+from py_phosphor_icons import get_svg, get_svg_inner, search_icons
+
+get_svg("house")  # the whole <svg> element
+get_svg_inner("house", "bold")  # just its contents
+search_icons("home")  # ranked IconEntry results
+```
+
+Weights are `thin`, `light`, `regular`, `bold`, `fill` and `duotone`; styles are
+`flat` and `stroke`. An unknown name raises `FileNotFoundError` with the closest
+matches suggested.
+
+## Ranking
+
+Search scoring is pluggable. Pass one per call, or set it for the process:
+
+```python
+from py_phosphor_icons import Ranking, search_icons, set_ranking
+
+search_icons("home", ranking=MyRanking())
+set_ranking("myapp.ranking.MyRanking")  # a class or a dotted path
+```