django-metroui5 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. django_metroui5-0.1.0/LICENSE +21 -0
  2. django_metroui5-0.1.0/PKG-INFO +392 -0
  3. django_metroui5-0.1.0/README.md +349 -0
  4. django_metroui5-0.1.0/django_metroui5.egg-info/PKG-INFO +392 -0
  5. django_metroui5-0.1.0/django_metroui5.egg-info/SOURCES.txt +55 -0
  6. django_metroui5-0.1.0/django_metroui5.egg-info/dependency_links.txt +1 -0
  7. django_metroui5-0.1.0/django_metroui5.egg-info/not-zip-safe +1 -0
  8. django_metroui5-0.1.0/django_metroui5.egg-info/requires.txt +8 -0
  9. django_metroui5-0.1.0/django_metroui5.egg-info/top_level.txt +1 -0
  10. django_metroui5-0.1.0/metroui5/__about__.py +11 -0
  11. django_metroui5-0.1.0/metroui5/__init__.py +9 -0
  12. django_metroui5-0.1.0/metroui5/apps.py +15 -0
  13. django_metroui5-0.1.0/metroui5/components.py +673 -0
  14. django_metroui5-0.1.0/metroui5/core.py +323 -0
  15. django_metroui5-0.1.0/metroui5/css.py +83 -0
  16. django_metroui5-0.1.0/metroui5/forms.py +50 -0
  17. django_metroui5-0.1.0/metroui5/html.py +155 -0
  18. django_metroui5-0.1.0/metroui5/renderers.py +309 -0
  19. django_metroui5-0.1.0/metroui5/static/metroui5/css/metro.all.css +1 -0
  20. django_metroui5-0.1.0/metroui5/static/metroui5/icons/icons.css +1 -0
  21. django_metroui5-0.1.0/metroui5/static/metroui5/icons/metro-ui-core.svg +993 -0
  22. django_metroui5-0.1.0/metroui5/static/metroui5/icons/metro-ui-core.ttf +0 -0
  23. django_metroui5-0.1.0/metroui5/static/metroui5/icons/metro-ui-core.woff +0 -0
  24. django_metroui5-0.1.0/metroui5/static/metroui5/js/metro.all.js +636 -0
  25. django_metroui5-0.1.0/metroui5/templates/metroui5/components/tile.html +32 -0
  26. django_metroui5-0.1.0/metroui5/templates/metroui5/forms/field.html +38 -0
  27. django_metroui5-0.1.0/metroui5/templates/metroui5/forms/form.html +47 -0
  28. django_metroui5-0.1.0/metroui5/templates/metroui5/layout/base.html +39 -0
  29. django_metroui5-0.1.0/metroui5/templatetags/__init__.py +1 -0
  30. django_metroui5-0.1.0/metroui5/templatetags/metroui5.py +545 -0
  31. django_metroui5-0.1.0/pyproject.toml +101 -0
  32. django_metroui5-0.1.0/setup.cfg +4 -0
  33. django_metroui5-0.1.0/setup.py +75 -0
  34. django_metroui5-0.1.0/tests/test_components.py +407 -0
  35. django_metroui5-0.1.0/tests/test_html.py +334 -0
  36. django_metroui5-0.1.0/tests/test_utils.py +424 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Maxim Harder
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,392 @@
1
+ Metadata-Version: 2.4
2
+ Name: django-metroui5
3
+ Version: 0.1.0
4
+ Summary: MetroUI v5 integration for Django 5.2.5+
5
+ Home-page: https://github.com/DevCraftClub/django-metroui5
6
+ Author: Maxim Harder
7
+ Author-email: Maxim Harder <dev@devcraft.club>
8
+ Maintainer-email: Maxim Harder <dev@devcraft.club>
9
+ License: MIT
10
+ Project-URL: Homepage, https://github.com/DevCraftClub/django-metroui5
11
+ Project-URL: Documentation (Russian), https://readme.devcraft.club
12
+ Project-URL: Documentation (English), https://github.com/DevCraftClub/django-metroui5/docs/en/
13
+ Project-URL: Repository, https://github.com/DevCraftClub/django-metroui5.git
14
+ Project-URL: Bug Tracker, https://github.com/DevCraftClub/django-metroui5/issues
15
+ Keywords: django,metroui,ui,frontend,framework,bootstrap-replacement
16
+ Classifier: Development Status :: 3 - Alpha
17
+ Classifier: Environment :: Web Environment
18
+ Classifier: Framework :: Django
19
+ Classifier: Framework :: Django :: 5.2
20
+ Classifier: Intended Audience :: Developers
21
+ Classifier: License :: OSI Approved :: MIT License
22
+ Classifier: Operating System :: OS Independent
23
+ Classifier: Programming Language :: Python
24
+ Classifier: Programming Language :: Python :: 3
25
+ Classifier: Programming Language :: Python :: 3.13
26
+ Classifier: Topic :: Internet :: WWW/HTTP
27
+ Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
28
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
29
+ Requires-Python: >=3.13
30
+ Description-Content-Type: text/markdown
31
+ License-File: LICENSE
32
+ Requires-Dist: Django>=5.2.5
33
+ Provides-Extra: dev
34
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
35
+ Requires-Dist: pytest-django>=4.5.0; extra == "dev"
36
+ Requires-Dist: black>=23.0.0; extra == "dev"
37
+ Requires-Dist: flake8>=6.0.0; extra == "dev"
38
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
39
+ Dynamic: author
40
+ Dynamic: home-page
41
+ Dynamic: license-file
42
+ Dynamic: requires-python
43
+
44
+ # Django MetroUI5
45
+
46
+ [![Python Version](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
47
+ [![Django Version](https://img.shields.io/badge/django-5.2.5+-green.svg)](https://www.djangoproject.com/)
48
+ [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](LICENSE)
49
+
50
+ **Django MetroUI5** - это Django пакет для интеграции MetroUI v5 с Django 5.2.5+ и Python 3.13+.
51
+
52
+ **Django MetroUI5** is a Django package for integrating MetroUI v5 with Django 5.2.5+ and Python 3.13+.
53
+
54
+ ## 🚀 Особенности / Features
55
+
56
+ - **Полная интеграция MetroUI v5** с Django / **Full MetroUI v5 integration** with Django
57
+ - **Template tags** для всех основных компонентов MetroUI / **Template tags** for all major MetroUI components
58
+ - **Автоматическое рендеринг форм** с MetroUI стилизацией / **Automatic form rendering** with MetroUI styling
59
+ - **Поддержка MetroUI компонентов**: tiles, cards, buttons, alerts, progress bars / **MetroUI component support**:
60
+ tiles, cards, buttons, alerts, progress bars
61
+ - **Responsive дизайн** для всех устройств / **Responsive design** for all devices
62
+ - **Django 5.2.5+ совместимость** / **Django 5.2.5+ compatibility**
63
+ - **Python 3.13+ поддержка** / **Python 3.13+ support**
64
+ - **Bilingual documentation** - English and Russian comments and docstrings
65
+ - **Comprehensive testing** - Full test coverage for all components
66
+ - **Online demo application** - Live demonstration of all features
67
+
68
+ ## 📋 Требования / Requirements
69
+
70
+ - Python 3.13+
71
+ - Django 5.2.5+
72
+ - MetroUI v5 (включен в пакет) / MetroUI v5 (included in package)
73
+
74
+ ## 🛠️ Быстрый старт / Quick Start
75
+
76
+ ### 1. Установка пакета / Package Installation
77
+
78
+ ```bash
79
+ # Клонирование репозитория / Clone repository
80
+ git clone https://github.com/DevCraftClub/django-metroui5.git
81
+ cd django-metroui5
82
+
83
+ # Установка в режиме разработки / Install in development mode
84
+ pip install -e .
85
+ ```
86
+
87
+ ### 2. Запуск демонстрационного приложения / Running Demo Application
88
+
89
+ ```bash
90
+ # Переход в папку с демо / Navigate to demo folder
91
+ cd example
92
+
93
+ # Проверка конфигурации / Check configuration
94
+ python3 manage.py check
95
+
96
+ # Запуск сервера разработки / Start development server
97
+ python3 manage.py runserver
98
+ ```
99
+
100
+ Демо приложение будет доступно по адресу: **http://127.0.0.1:8000/** / Demo application will be available at: *
101
+ *http://127.0.0.1:8000/**
102
+
103
+ ### 3. Доступные страницы демо / Available Demo Pages
104
+
105
+ - **Главная** (`/`) - Обзор всех возможностей MetroUI5 / **Main** (`/`) - Overview of all MetroUI5 capabilities
106
+ - **Формы** (`/forms/`) - Демонстрация рендеринга Django форм / **Forms** (`/forms/`) - Django form rendering
107
+ demonstration
108
+ - **Компоненты** (`/components/`) - Все доступные UI компоненты / **Components** (`/components/`) - All available UI
109
+ components
110
+ - **Tiles** (`/tiles/`) - Примеры MetroUI tiles / **Tiles** (`/tiles/`) - MetroUI tiles examples
111
+
112
+ ## 🧪 Тестирование / Testing
113
+
114
+ ### Запуск тестов / Running Tests
115
+
116
+ ```bash
117
+ # В корневой папке проекта / In project root folder
118
+ pytest
119
+
120
+ # Тесты с покрытием / Tests with coverage
121
+ pytest --cov=metroui5
122
+
123
+ # Django тесты / Django tests
124
+ cd example
125
+ python3 manage.py test
126
+ ```
127
+
128
+ ## 📚 Документация / Documentation
129
+
130
+ - **[CHANGELOG.md](CHANGELOG.md)** - История изменений / Change history
131
+ - **[CONTRIBUTING.md](CONTRIBUTING.md)** - Руководство по вкладу / Contribution guide
132
+ - **Inline Documentation** - Bilingual comments and docstrings throughout the codebase
133
+ - **Test Coverage** - Comprehensive test suite with detailed examples
134
+
135
+ ## 🎯 Использование в вашем проекте / Using in Your Project
136
+
137
+ ### 1. Добавьте в INSTALLED_APPS / Add to INSTALLED_APPS
138
+
139
+ ```python
140
+ INSTALLED_APPS = [
141
+ # ... другие приложения / ... other applications
142
+ 'metroui5',
143
+ ]
144
+ ```
145
+
146
+ ### 2. Настройте MetroUI (опционально) / Configure MetroUI (optional)
147
+
148
+ ```python
149
+ # settings.py
150
+ METROUI5 = {
151
+ 'css_url': {
152
+ 'url': 'metroui5/css/metro.all.css',
153
+ 'integrity': None,
154
+ 'crossorigin': None,
155
+ },
156
+ 'javascript_url': {
157
+ 'url': 'metroui5/js/metro.all.js',
158
+ 'integrity': None,
159
+ 'crossorigin': None,
160
+ },
161
+ 'icons_css_url': {
162
+ 'url': 'metroui5/icons/icons.css',
163
+ 'integrity': None,
164
+ 'crossorigin': None,
165
+ },
166
+ 'theme': 'default',
167
+ 'set_placeholder': True,
168
+ 'required_css_class': 'required',
169
+ 'error_css_class': 'error',
170
+ 'success_css_class': 'success',
171
+ }
172
+ ```
173
+
174
+ ### 3. Используйте в шаблонах / Use in Templates
175
+
176
+ ```html
177
+ {% load metroui5 %}
178
+
179
+ <!DOCTYPE html>
180
+ <html>
181
+ <head>
182
+ <title>{% block title %}My App{% endblock %}</title>
183
+ {% metroui5_css %} {% metroui5_icons_css %}
184
+ </head>
185
+ <body>
186
+ <div class="container">{% block content %}{% endblock %}</div>
187
+
188
+ {% metroui5_javascript %}
189
+ </body>
190
+ </html>
191
+ ```
192
+
193
+ ## 🧩 Template Tags
194
+
195
+ ### CSS и JavaScript / CSS and JavaScript
196
+
197
+ - `{% metroui5_css %}` - Включает CSS файл MetroUI / Includes MetroUI CSS file
198
+ - `{% metroui5_javascript %}` - Включает JavaScript файл MetroUI / Includes MetroUI JavaScript file
199
+ - `{% metroui5_icons_css %}` - Включает CSS файл иконок MetroUI / Includes MetroUI icons CSS file
200
+
201
+ ### Формы / Forms
202
+
203
+ - `{% metroui5_form form %}` - Рендерит форму с MetroUI стилизацией / Renders form with MetroUI styling
204
+ - `{% metroui5_field field %}` - Рендерит поле формы / Renders form field
205
+ - `{% metroui5_form_errors form %}` - Рендерит ошибки формы / Renders form errors
206
+ - `{% metroui5_formset formset %}` - Рендерит формсет / Renders formset
207
+
208
+ ### Компоненты / Components
209
+
210
+ - `{% metroui5_button content %}` - MetroUI кнопка / MetroUI button
211
+ - `{% metroui5_tile title %}` - MetroUI tile
212
+ - `{% metroui5_card %}` - MetroUI карточка / MetroUI card
213
+ - `{% metroui5_progress value %}` - MetroUI progress bar
214
+ - `{% metroui5_alert content %}` - MetroUI alert
215
+ - `{% metroui5_messages %}` - Django сообщения в MetroUI стиле / Django messages in MetroUI style
216
+
217
+ ## 🎨 Примеры использования / Usage Examples
218
+
219
+ ### Кнопки / Buttons
220
+
221
+ ```html
222
+ {% metroui5_button "Submit" button_type="primary" size="lg" %} {%
223
+ metroui5_button "Cancel" button_type="secondary" outline=True %}
224
+ ```
225
+
226
+ ### Tiles
227
+
228
+ ```html
229
+ {% metroui5_tile "Settings" size="medium" color="blue" icon="cog" %} {%
230
+ metroui5_tile "Users" size="large" color="green" content="1,234 active users" %}
231
+ ```
232
+
233
+ ### Формы / Forms
234
+
235
+ ```html
236
+ <!-- Рендеринг всей формы / Render entire form -->
237
+ {% metroui5_form form %}
238
+
239
+ <!-- Рендеринг отдельных полей / Render individual fields -->
240
+ {% metroui5_field form.username %} {% metroui5_field form.email %}
241
+ ```
242
+
243
+ ### Progress Bars
244
+
245
+ ```html
246
+ {% metroui5_progress 75 color="blue" %} {% metroui5_progress 50 color="green"
247
+ size="large" %}
248
+ ```
249
+
250
+ ## 🔧 Разработка / Development
251
+
252
+ ### Установка для разработки / Development Installation
253
+
254
+ ```bash
255
+ git clone https://github.com/DevCraftClub/django-metroui5.git
256
+ cd django-metroui5
257
+ pip install -e .[dev]
258
+ ```
259
+
260
+ ### Проверка кода / Code Quality
261
+
262
+ ```bash
263
+ black --check .
264
+ flake8 .
265
+ mypy .
266
+ ```
267
+
268
+ ## 📦 Структура проекта / Project Structure
269
+
270
+ ```
271
+ django-metroui5/
272
+ ├── metroui5/ # Основной пакет / Main package
273
+ │ ├── templatetags/ # Template tags
274
+ │ ├── templates/ # Шаблоны MetroUI / MetroUI templates
275
+ │ ├── static/ # Статические файлы MetroUI / MetroUI static files
276
+ │ ├── components.py # UI компоненты / UI components
277
+ │ ├── forms.py # Рендеринг форм / Form rendering
278
+ │ ├── renderers.py # Система рендереров / Renderer system
279
+ │ └── ...
280
+ ├── example/ # Демонстрационное приложение / Demo application
281
+ ├── tests/ # Тесты / Tests
282
+ ├── docs/ # Документация / Documentation
283
+ └── ...
284
+ ```
285
+
286
+ ## 🌟 Особенности реализации / Implementation Features
287
+
288
+ - **Следование принципам DRY** - переиспользование кода между компонентами / **DRY principles** - code reuse between
289
+ components
290
+ - **Bilingual documentation** - English and Russian comments and docstrings throughout
291
+ - **Generic шаблоны** - базовые шаблоны для переиспользования / **Generic templates** - base templates for reuse
292
+ - **Комплексное тестирование** - покрытие всех основных функций / **Comprehensive testing** - coverage of all main
293
+ functions
294
+ - **Современная архитектура** - использование Python 3.13+ возможностей / **Modern architecture** - using Python 3.13+
295
+ capabilities
296
+ - **Full MetroUI v5 integration** - complete component library with Django integration
297
+
298
+ ## 📈 Следующие шаги / Next Steps
299
+
300
+ ### Краткосрочные задачи / Short-term Tasks
301
+
302
+ 1. ✅ Добавить больше MetroUI компонентов / Add more MetroUI components
303
+ 2. ✅ Расширить систему тестирования / Expand testing system
304
+ 3. ✅ Улучшить документацию / Improve documentation
305
+ 4. ✅ Создать онлайн демо / Create online demo
306
+
307
+ ### Среднесрочные задачи / Medium-term Tasks
308
+
309
+ 1. Добавить поддержку тем / Add theme support
310
+ 2. Создать дополнительные рендереры / Create additional renderers
311
+ 3. Добавить поддержку Jinja2 / Add Jinja2 support
312
+
313
+ ### Долгосрочные задачи / Long-term Tasks
314
+
315
+ 1. ✅ Создать онлайн демо / Create online demo
316
+ 2. Добавить поддержку других версий Django / Add support for other Django versions
317
+ 3. Создать экосистему плагинов / Create plugin ecosystem
318
+
319
+ ## 🤝 Вклад в проект / Contributing
320
+
321
+ Мы приветствуем вклад в развитие проекта! Пожалуйста, ознакомьтесь с [CONTRIBUTING.md](CONTRIBUTING.md) для получения
322
+ дополнительной информации.
323
+
324
+ We welcome contributions to the project! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
325
+
326
+ ## 📄 Лицензия / License
327
+
328
+ Этот проект распространяется под лицензией MIT. См. файл [LICENSE](LICENSE) для получения дополнительной информации.
329
+
330
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
331
+
332
+ ## 🙏 Благодарности / Acknowledgments
333
+
334
+ - [MetroUI](https://metroui.org.ua/) - за отличный UI фреймворк / for excellent UI framework
335
+ - [Django](https://www.djangoproject.com/) - за мощный веб-фреймворк / for powerful web framework
336
+ - [django-bootstrap5](https://github.com/zostera/django-bootstrap5) - за вдохновение архитектуры / for architecture
337
+ inspiration
338
+
339
+ ## 📞 Поддержка / Support
340
+
341
+ Если у вас есть вопросы или проблемы: / If you have questions or issues:
342
+
343
+ - Создайте [Issue](https://github.com/DevCraftClub/django-metroui5/issues) / Create
344
+ an [Issue](https://github.com/DevCraftClub/django-metroui5/issues)
345
+ - Обратитесь к [документации](https://django-metroui5.readthedocs.io/) / Check
346
+ the [documentation](https://django-metroui5.readthedocs.io/)
347
+ - Присоединитесь к обсуждениям в [Discussions](https://github.com/DevCraftClub/django-metroui5/discussions) / Join
348
+ discussions in [Discussions](https://github.com/DevCraftClub/django-metroui5/discussions)
349
+
350
+ ---
351
+
352
+ **Django MetroUI5** - Сделайте ваши Django приложения красивыми с MetroUI v5! 🎨✨
353
+
354
+ **Django MetroUI5** - Make your Django applications beautiful with MetroUI v5! 🎨✨
355
+
356
+ ## 🎯 Текущий статус проекта / Current Project Status
357
+
358
+ ### ✅ Завершенные задачи / Completed Tasks
359
+
360
+ - **Bilingual Documentation** - English and Russian comments/docstrings throughout codebase
361
+ - **Comprehensive Testing** - Full test coverage for all components and utilities
362
+ - **Online Demo Application** - Live demonstration of all MetroUI5 features
363
+ - **MetroUI v5 Integration** - Complete component library with Django integration
364
+ - **Form Rendering System** - Automatic MetroUI styling for Django forms
365
+ - **Template Tags** - Complete set of MetroUI component template tags
366
+ - **Static Files Management** - Proper MetroUI CSS/JS integration
367
+
368
+ ### 🔄 В процессе / In Progress
369
+
370
+ - **Jinja2 Support** - Template engine compatibility
371
+ - **Plugin Ecosystem** - Extensible component system
372
+
373
+ ### 📋 Планируется / Planned
374
+
375
+ - **Theme System** - Multiple MetroUI themes
376
+ - **Additional Renderers** - Specialized form renderers
377
+ - **Performance Optimization** - Enhanced rendering speed
378
+
379
+ ## 🚀 Быстрый тест / Quick Test
380
+
381
+ Хотите быстро протестировать пакет? Запустите демо приложение: / Want to quickly test the package? Run the demo
382
+ application:
383
+
384
+ ```bash
385
+ # Установка и запуск за 3 команды / Installation and launch in 3 commands
386
+ pip install -e .
387
+ cd example
388
+ python3 manage.py runserver
389
+ ```
390
+
391
+ Откройте http://127.0.0.1:8000/ в браузере и наслаждайтесь MetroUI5! 🎉 / Open http://127.0.0.1:8000/ in your browser and
392
+ enjoy MetroUI5! 🎉