Metadata-Version: 2.4
Name: django-brick-astley
Version: 0.3.0
Summary: Reusable bricks for Django templates
Author-email: Philipp Bosch <hello@pb.io>
License-Expression: MIT
Project-URL: Homepage, https://github.com/philippbosch/django-brick-astley
Project-URL: Repository, https://github.com/philippbosch/django-brick-astley
Project-URL: Documentation, https://django-brick-astley.readthedocs.io
Project-URL: Bug Tracker, https://github.com/philippbosch/django-brick-astley/issues
Keywords: django,components,templates,bricks
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3.14
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django :: 5.2
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=3.2
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-django>=4.5; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: flake8>=6.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Dynamic: license-file

# django-brick-astley

Reusable bricks for Django templates.

[![PyPI version](https://badge.fury.io/py/django-brick-astley.svg)](https://pypi.org/project/django-brick-astley/)
[![Documentation Status](https://readthedocs.org/projects/django-brick-astley/badge/?version=latest)](https://django-brick-astley.readthedocs.io/)

**[Documentation](https://django-brick-astley.readthedocs.io/)** | **[PyPI](https://pypi.org/project/django-brick-astley/)** | **[GitHub](https://github.com/philippbosch/django-brick-astley)**

## Installation

```bash
pip install django-brick-astley
```

## Usage

Add `brickastley` to your `INSTALLED_APPS`:

```python
INSTALLED_APPS = [
    # ...
    'brickastley',
    # ...
]
```

For detailed usage instructions, see the [full documentation](https://django-brick-astley.readthedocs.io/).

## Example Project

This repository includes a Django demo project in the `example/` directory. To run it:

```bash
cd example
python -m venv .venv
source .venv/bin/activate
pip install -e ..
pip install Django
python manage.py migrate
python manage.py runserver
```

Visit http://127.0.0.1:8000/ to see the example in action.

## Development

Clone the repository:

```bash
git clone https://github.com/philippbosch/django-brick-astley.git
cd django-brick-astley
```

Create and activate a virtual environment:

```bash
# Create virtual environment
python -m venv .venv

# Activate virtual environment
source .venv/bin/activate
```

Install in development mode with dev dependencies:

```bash
pip install -e ".[dev]"
```

Run tests:

```bash
pytest
```


## License

MIT
