python-lucide 0.1.0__tar.gz

python_lucide-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

python_lucide-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mike Macpherson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_lucide-0.1.0/PKG-INFO

@@ -0,0 +1,315 @@
+Metadata-Version: 2.4
+Name: python-lucide
+Version: 0.1.0
+Summary: A Python package for working with Lucide icons
+Project-URL: Bug Tracker, https://github.com/mmacpherson/python-lucide/issues
+Project-URL: Homepage, https://github.com/mmacpherson/python-lucide
+Project-URL: Source Code, https://github.com/mmacpherson/python-lucide
+Author: Lucide Contributors
+License: MIT
+License-File: LICENSE
+Keywords: icons,lucide,sqlite,svg
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# python-lucide
+
+A Python package for working with [Lucide icons](https://lucide.dev/). This package allows you to:
+
+1. Build a SQLite database of Lucide icons
+2. Serve Lucide SVG icons from a Python application
+3. Customize icons with classes and attributes
+
+## Installation
+
+### Basic Installation
+```bash
+pip install lucide
+```
+
+This installs the core package without the pre-built icons database. You'll need to build the database yourself using the `lucide-db` command.
+
+### Installation with Pre-built Database
+```bash
+pip install "lucide"
+```
+
+This installs the package with a pre-built Lucide icons database, so you can use it right away without building it yourself.
+
+### Development Installation
+If you plan to contribute to `python-lucide`, see the "Development" section for setup instructions.
+
+## Usage
+
+### Getting an Icon
+
+```python
+from lucide import lucide_icon
+
+# Get a basic icon
+svg_content = lucide_icon("home")
+
+# Add a CSS class
+svg_content = lucide_icon("settings", cls="my-icon-class")
+
+# Add custom attributes
+svg_content = lucide_icon("arrow-up", attrs={"width": "32", "height": "32"})
+
+# Provide fallback text for when an icon is missing
+svg_content = lucide_icon("some-icon", fallback_text="Icon")
+```
+
+### Building the Icon Database
+
+#### Using the Command-Line Tool
+
+The package installs a command-line tool called `lucide-db` that you can use to build the database:
+
+```bash
+# Build a database with all icons
+lucide-db
+
+# Specify a custom output path
+lucide-db -o /path/to/output.db
+
+# Use a specific Lucide version
+lucide-db -t 0.500.0
+
+# Include only specific icons
+lucide-db -i home,settings,user
+
+# Include icons from a file (one name per line)
+lucide-db -f my-icons.txt
+
+# Enable verbose output
+lucide-db -v
+```
+
+#### Using the Python API
+
+You can also build the database programmatically:
+
+```python
+from lucide.cli import download_and_build_db
+
+# Build a custom database
+db_path = download_and_build_db(
+    output_path="custom-icons.db",
+    tag="0.511.0",
+    icon_list=["home", "settings", "user"]
+)
+```
+
+### Getting a List of Available Icons
+
+```python
+from lucide import get_icon_list
+
+# Get all available icon names
+icons = get_icon_list()
+print(icons)  # ['activity', 'airplay', 'alert-circle', ...]
+```
+
+## Configuration
+
+The package will look for the icons database in the following locations (in order):
+
+1. The path specified in the `LUCIDE_DB_PATH` environment variable
+2. In the package data directory (if installed with the `db` extra)
+3. In the current working directory as `lucide-icons.db`
+
+## Example Web Framework Integration
+
+### Flask
+
+```python
+from flask import Flask
+from lucide import lucide_icon
+
+app = Flask(__name__)
+
+@app.route('/icons/<icon_name>')
+def serve_icon(icon_name):
+    svg = lucide_icon(icon_name, cls="my-icon")
+    return svg, 200, {'Content-Type': 'image/svg+xml'}
+```
+
+### FastAPI
+
+```python
+from fastapi import FastAPI
+from fastapi.responses import Response
+from lucide import lucide_icon
+
+app = FastAPI()
+
+@app.get("/icons/{icon_name}")
+def serve_icon(icon_name: str):
+    svg = lucide_icon(icon_name, cls="my-icon")
+    return Response(content=svg, media_type="image/svg+xml")
+```
+
+## Development
+
+This project uses `uv` for project and virtual environment management, and `pre-commit` for code quality checks. A `Makefile` is also provided for common development tasks.
+
+### Setup Development Environment
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/mmacpherson/python-lucide.git
+    cd python-lucide
+    ```
+
+2.  **Create a virtual environment and install dependencies:**
+    This project uses `uv` for fast environment management and dependency installation.
+    ```bash
+    # Create a virtual environment in .venv/
+    uv venv
+    # Activate the virtual environment
+    # On macOS/Linux:
+    source .venv/bin/activate
+    # On Windows (PowerShell):
+    # .venv\\Scripts\\Activate.ps1
+    # On Windows (CMD):
+    # .venv\\Scripts\\activate.bat
+
+    # Install the package in editable mode with development dependencies
+    uv pip install -e ".[dev]"
+    ```
+    This command installs `lucide` in "editable" mode (`-e`), meaning changes you make to the source code will be reflected immediately. It also installs all dependencies listed under the `[dev]` extra in your `pyproject.toml` (like `pytest`, `ruff`, and `pre-commit`).
+
+    Alternatively, you can use the `Makefile` target:
+    ```bash
+    make env
+    # Then activate the environment as shown above.
+    ```
+
+3.  **Install pre-commit hooks:**
+    ```bash
+    uv run pre-commit install
+    ```
+    Or use the Makefile:
+    ```bash
+    make install-hooks
+    ```
+
+<details>
+<summary>Alternative: Using Python's venv and pip</summary>
+
+If you prefer not to use `uv` or `make`, you can use Python's built-in `venv` module and `pip`:
+
+1.  **Clone the repository (if not already done):**
+    ```bash
+    git clone https://github.com/mmacpherson/python-lucide.git
+    cd python-lucide
+    ```
+
+2.  **Create and activate a virtual environment:**
+    ```bash
+    python -m venv .venv
+    # On macOS/Linux:
+    source .venv/bin/activate
+    # On Windows (PowerShell):
+    # .venv\\Scripts\\Activate.ps1
+    # On Windows (CMD):
+    # .venv\\Scripts\\activate.bat
+    ```
+
+3.  **Install dependencies:**
+    ```bash
+    pip install -e ".[dev]"
+    ```
+
+4.  **Install pre-commit hooks:**
+    ```bash
+    pre-commit install
+    ```
+
+</details>
+
+### Running Tests
+
+After setting up your development environment, run tests using `pytest`.
+You can use the `Makefile`:
+```bash
+make test
+```
+Or run `pytest` directly via `uv`:
+```bash
+uv run pytest
+```
+
+### Linting and Formatting
+
+This project uses `ruff` for linting and formatting, managed via `pre-commit`. The hooks will run automatically on commit.
+To run all hooks manually across all files, use the `Makefile`:
+```bash
+make run-hooks-all-files
+```
+Or run `pre-commit` directly via `uv`:
+```bash
+uv run pre-commit run --all-files
+```
+
+You can also run `ruff` commands directly:
+```bash
+uv run ruff check .
+uv run ruff format .
+```
+
+### Building the Icon Database
+
+The packaged database can be rebuilt using the `lucide-db` command-line tool. To update the database bundled with the `[db]` extra (typically stored at `src/lucide/data/lucide-icons.db`):
+
+Using the `Makefile` (recommended for consistency):
+```bash
+# Replace <version> with the desired Lucide tag, e.g., 0.511.0
+make db TAG=<version>
+```
+Or directly using `lucide-db` (ensure your virtual environment is active):
+```bash
+# Replace <version> with the desired Lucide tag
+uv run lucide-db -o src/lucide/data/lucide-icons.db -t <version> -v
+```
+The default tag used by `make db` is specified in the `Makefile`.
+
+### Building the Package
+
+To build the sdist and wheel for distribution:
+```bash
+python -m build
+```
+Or, if you have `hatch` installed (it's part of `[dev]` dependencies):
+```bash
+hatch build
+```
+
+### Makefile Targets
+A `Makefile` is provided with common development tasks. Run `make help` to see available targets, including:
+*   `env`: Sets up the development environment (creates `.venv` and installs dependencies).
+*   `db`: Rebuilds the Lucide icon database.
+*   `test`: Runs tests.
+*   `install-hooks`: Installs pre-commit hooks.
+*   `run-hooks-all-files`: Runs all pre-commit hooks on all files.
+*   `clean`: Removes build artifacts, `__pycache__`, etc.
+*   `nuke`: A more thorough clean, including the `uv` cache if present and the `.venv` directory.
+
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.