Skip to content

Commit a19e547

Browse files
Merge main + resolve conflicts
2 parents 13e6632 + 556f47a commit a19e547

File tree

8 files changed

+438
-374
lines changed

8 files changed

+438
-374
lines changed

.github/workflows/ci.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ jobs:
1212
- run: pipx install "poetry>=1.1.12,<2"
1313
- uses: actions/setup-python@v5
1414
with:
15-
python-version: "3.12"
16-
cache: 'poetry'
15+
python-version: "3.13"
16+
cache: "poetry"
1717
- run: pip install tox
18-
- run: tox -e lint,py312-dj50
18+
- run: tox -e lint,py313-dj51
1919
test_compatibility:
2020
needs: test
2121
runs-on: ubuntu-latest
@@ -26,16 +26,16 @@ jobs:
2626
# Test with all supported Django versions, for all compatible Python versions.
2727
# See https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django for the official matrix.
2828
# Additionally test on Django’s main branch with the most recent Python version.
29-
- python: "3.8"
30-
toxenv: py38-dj32,py38-dj42
3129
- python: "3.9"
32-
toxenv: py39-dj32,py39-dj42
30+
toxenv: py39-dj42
3331
- python: "3.10"
34-
toxenv: py310-dj32,py310-dj42,py310-dj50,py310-djmain
32+
toxenv: py310-dj42,py310-dj51,py310-dj52
3533
- python: "3.11"
36-
toxenv: py311-dj42,py311-dj50,py311-djmain
34+
toxenv: py311-dj42,py311-dj51,py311-dj52
3735
- python: "3.12"
38-
toxenv: py312-dj42,py312-djmain
36+
toxenv: py312-dj42,py312-dj52
37+
- python: "3.13"
38+
toxenv: py313-dj42,py313-dj52,py312-djmain
3939
steps:
4040
- uses: actions/checkout@v4
4141
- run: pipx install "poetry>=1.1.12,<2"
@@ -54,7 +54,7 @@ jobs:
5454
- uses: actions/checkout@v4
5555
- uses: actions/setup-node@v4
5656
with:
57-
node-version-file: '.nvmrc'
57+
node-version-file: ".nvmrc"
5858
- id: node-cache
5959
uses: actions/cache@v3
6060
with:
@@ -68,7 +68,7 @@ jobs:
6868
- uses: actions/setup-python@v5
6969
with:
7070
python-version-file: pyproject.toml
71-
cache: 'poetry'
71+
cache: "poetry"
7272
- run: poetry install
7373
- run: poetry run django-admin runserver --settings=tests.settings.production --pythonpath=. &
7474
# Docs website build.

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
11
# Changelog
22

3+
## [Unreleased]
4+
5+
## [1.3.0](https://github.com/torchbox/django-pattern-library/releases/tag/v1.3.0) - 2024-12-11
6+
7+
### Added
8+
9+
- Add support for Django 5.1 ([#251](https://github.com/torchbox/django-pattern-library/pull/251))
10+
11+
### Removed
12+
13+
- Drop support for Python 3.8 ([#251](https://github.com/torchbox/django-pattern-library/pull/251))
14+
- Drop support for Django 4.1 ([#242](https://github.com/torchbox/django-pattern-library/pull/242))
15+
16+
### Documentation
17+
18+
- Note requirement for `.md` extension for pattern documentation files ([#248](https://github.com/torchbox/django-pattern-library/pull/248))
19+
- Mention complementary package django-viewcomponent, and django-lookbook as an alternative. ([#250](https://github.com/torchbox/django-pattern-library/pull/250))
20+
21+
### Maintenance
22+
23+
- Test with Python 3.12 ([#242](https://github.com/torchbox/django-pattern-library/pull/242))
24+
325
## [1.2.0](https://github.com/torchbox/django-pattern-library/releases/tag/v1.2.0) - 2024-01-16
426

527
### Added

docs/community/related-projects.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ Here are other projects that are related to django-pattern-library, and may be r
99
- [django-component-tags](https://github.com/syse-i/django-component-tags) – Create advanced HTML components using Django Tags.
1010
- [slippers](https://github.com/mixxorz/slippers) – Reusable components for Django, without writing a single line of Python.
1111
- (Jinja only, incompatible but interesting) [JinjaX](https://jinjax.scaletti.dev/) – Write server-side components as single Jinja template files. Use them as HTML tags without doing any importing.
12+
- [django-viewcomponent](https://github.com/rails-inspire-django/django-viewcomponent) - Build reusable components in Django, inspired by Rails ViewComponent, the components built by django-viewcomponent can be used in both Django template or Python code.
1213

1314
## Alternatives
1415

1516
- [Storybook](https://storybook.js.org/), and in particular [Storybook for Server](https://github.com/storybookjs/storybook/tree/master/app/server) – Storybook integration with server-rendered UI components.
1617
- [Pattern Lab](http://patternlab.io/) – PHP or Node pattern library, from which this project is heavily inspired.
1718
- [Astrum](http://astrum.nodividestudio.com/) – Similar to Pattern Lab, Node based.
1819
- [rikki-patterns](https://github.com/springload/rikki-patterns) – Experimental Django-friendly pattern library generator, for Jinja2 and Nunjucks templates
20+
- [django-lookbook](https://github.com/rails-inspire-django/django-lookbook) - Empower your Django development with this pluggable app for creating a robust component library. Includes preview system, documentation engine, and parameter editor for building modular UI effortlessly.
1921

2022

2123
## Pattern libraries based on Django

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ poetry add --dev django-pattern-library
1717

1818
We support:
1919

20-
- Django 3.2, 4.0, 4.1 (experimental), 4.2 (experimental)
21-
- Python 3.7, 3.8, 3.9, 3.10, 3.11 (experimental)
20+
- Django 4.2, 5.0, 5.1
21+
- Python 3.9, 3.10, 3.11, 3.12
2222
- Django Templates only, no Jinja support
2323
- Modern “evergreen” desktop and mobile browsers
2424

docs/guides/usage-tips.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ You may also consider using the [`render_patterns` command](../reference/api.md#
1010

1111
## Document your patterns
1212

13-
Patterns support defining a custom `name` in YAML, as well as rendering fully-fledged documentation in Markdown. Create a file next to the template to document it:
13+
Patterns support defining a custom `name` in YAML, as well as rendering fully-fledged documentation in Markdown. Create a file next to the template to document it, ensuring the filename has a `.md` extension (e.g., `call_to_action.md`):
14+
1415

1516
```markdown
1617
This template can be used in different places. In streamfield block

0 commit comments

Comments
 (0)