PyPI - django-sample-components - Versions diffs - 0.1.0__py3-none-any.whl - Mend

django-sample-components 0.1.0__py3-none-any.whl

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 (24) hide show

django_sample_components/__init__.py ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ # This line is vital so that other Django projects can import your AppConfig
2	+ default_app_config = 'django_sample_components.apps.DjangoSampleComponents'

django_sample_components/admin.py ADDED Viewed

File without changes

django_sample_components/apps.py ADDED Viewed

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+class DjangoSampleComponents(AppConfig):
+    name = 'django_sample_components'
+    verbose_name = _('Django Sample Components')

django_sample_components/models.py ADDED Viewed

File without changes

django_sample_components/static/css/style.css ADDED Viewed

@@ -0,0 +1,14 @@
+.alert.simple-alert{
+    background-color: #ff000000;
+    border-style: solid;
+    border-width: 2px;
+    margin: 5px;
+    padding:  11px 15px;
+}
+.simple-alert-icon{
+    padding: 0.6rem;
+    border-radius: 0.375rem;
+    background-color: var(--bs-alert-bg);
+    color: var(--bs-alert-color);
+}

django_sample_components/static/js/main.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ console.log('main.js loaded');

django_sample_components/templates/django_sample_components/components/simple_alert.html ADDED Viewed

@@ -0,0 +1,13 @@
+<div
+    class="simple-alert alert {{ alert_class }} alert-outline-{{ text_class }} d-flex justify-content-between align-items-center animate-slide-down"
+    role="alert">
+    <div class="d-flex align-items-center">
+        <span class="alert-icon bg-{{ text_class }} rounded bg-opacity-10 me-3 d-flex align-items-center justify-content-center">
+            <i class="simple-alert-icon {{ icon_class }} text-{{ text_class }}"></i>
+        </span>
+        <p class="mb-0">
+            {{ slot_content }}
+        </p>
+    </div>
+    {% comment %} <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button> {% endcomment %}
+</div>

django_sample_components/templates/django_sample_components/pages/alert.html ADDED Viewed

@@ -0,0 +1,36 @@
+{% extends 'django_sample_components/pages/master.html' %}
+{% load sample_tags %}
+{% block content %}
+    <h1>Alert Page</h1>
+    {% simple_alert %}
+        This is the content for <i>simple_alert</i>.
+    {% endsimple_alert %}
+    {% simple_alert type="info" %}
+        info alert example.
+    {% endsimple_alert %}
+    {% simple_alert type="success" %}
+        success alert example.
+    {% endsimple_alert %}
+    {% simple_alert type="warning" %}
+        warning alert example.
+    {% endsimple_alert %}
+    {% simple_alert type="danger" %}
+        danger alert example.
+    {% endsimple_alert %}
+    {% simple_alert %}
+        Este é o alerta pai.
+        {% simple_alert %}
+            Este é o alerta filho dentro do alerta pai.
+        {% endsimple_alert %}
+    {% endsimple_alert %}
+{% endblock %}

django_sample_components/templates/django_sample_components/pages/greeting.html ADDED Viewed

@@ -0,0 +1,9 @@
+{% extends 'django_sample_components/pages/master.html' %}
+{% load sample_tags %}
+{% block content %}
+    <h1>Greeting Page</h1>
+    <p>{% greeting "My dear visitor" %}</p>
+{% endblock %}

django_sample_components/templates/django_sample_components/pages/home.html ADDED Viewed

@@ -0,0 +1,11 @@
+{% extends 'django_sample_components/pages/master.html' %}
+{% load sample_tags %}
+{% block content %}
+    <h1>Welcome to Django Sample Components - Version {{ versao }}</h1>
+    <p>To learn more about the library, <a href="{{ url_pypi }}">visit the PyPI page</a></p>
+    <p>Check out the source code on <a href="{{ url_github }}">GitHub</a></p>
+    <p>This template was loaded directly from the library package!</p>
+{% endblock %}

django_sample_components/templates/django_sample_components/pages/master.html ADDED Viewed

@@ -0,0 +1,39 @@
+{% load static i18n %}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{% block title %}Django Sample Componentes{% endblock %}</title>
+    <link rel="stylesheet" href="{% static 'css/style.css' %}">
+    <script src="{% static 'js/main.js' %}"></script>
+    {% block third_party_head_libs %}
+        {% comment %} Bootstrap {% endcomment %}
+        <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-sRIl4kxILFvY47J16cr9ZwB07vP4J8+LH7qKQnuqkuIAvNWLzeN8tE5YBujZqJLB" crossorigin="anonymous">
+        {% comment %} Font Awesome {% endcomment %}
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css" integrity="..." crossorigin="anonymous" referrerpolicy="no-referrer" />
+    {% endblock %}
+    {% block extra_head %}{% endblock %}
+</head>
+<body>
+    <header>
+        {% include "django_sample_components/partials/menu.html" %}
+    </header>
+    <main>
+        {% block content %}{% endblock %}
+    </main>
+    <footer>
+        <p>&copy; {{ year|default:2025 }} My Django Sample Components</p>
+    </footer>
+    {% block extra_scripts %}{% endblock %}
+    {% block third_party_head_js %}
+        {% comment %} Bootstrap JS{% endcomment %}
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css" integrity="..." crossorigin="anonymous" referrerpolicy="no-referrer" />
+    {% endblock %}
+</body>
+</html>

django_sample_components/templates/django_sample_components/partials/menu.html ADDED Viewed

@@ -0,0 +1,7 @@
+{% load static i18n %}
+<nav>
+    <a href="/">{% trans "Home" %}</a>
+    <a href="{% url 'django_sample_components:greeting' %}">{% trans "Greeting" %}</a>
+    <a href="{% url 'django_sample_components:alert' %}">{% trans "Alert" %}</a>
+</nav>

django_sample_components/templatetags/__init__.py ADDED Viewed

@@ -0,0 +1,5 @@
+# Esta linha é vital para que outros projetos Django possam importar sua AppConfig
+default_app_config = 'django_sample_components.apps.DjangoSampleComponents'
+# Defina a versão aqui (boa prática)
+__version__ = '0.1.0'

django_sample_components/templatetags/sample_tags/__init__.py ADDED Viewed

@@ -0,0 +1,16 @@
+from django import template
+from .greeting import greeting
+from .shout import shout
+from .show_today_timestamp import show_today_timestamp
+from .simple_alert import simple_alert
+register = template.Library()
+# 1. simple_tags
+register.simple_tag(show_today_timestamp)
+register.simple_tag(greeting)
+# 2. simple_block_tags
+register.simple_block_tag(shout)
+register.simple_block_tag(simple_alert)

django_sample_components/templatetags/sample_tags/greeting.py ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ def greeting(name):
2	+ return f"Hello, {name}!"

django_sample_components/templatetags/sample_tags/shout.py ADDED Viewed

@@ -0,0 +1,5 @@
+from django.utils.safestring import SafeString, mark_safe
+def shout(content: SafeString, bg_color=None):
+    return mark_safe(f"<h2 style='text-transform:uppercase; background-color:{bg_color}'>{content}!!!!</h2>")

django_sample_components/templatetags/sample_tags/show_today_timestamp.py ADDED Viewed

@@ -0,0 +1,5 @@
+import time
+def show_today_timestamp():
+    return str(int(time.time()))

django_sample_components/templatetags/sample_tags/simple_alert.py ADDED Viewed

@@ -0,0 +1,41 @@
+from django.template.loader import render_to_string
+from django.utils.safestring import SafeString
+def simple_alert(
+    content: SafeString,
+    type: str = 'info',
+):
+    """
+    Renders a simple alert box with the given content and optional prefix text.
+    Adds a Font Awesome icon based on the alert type.
+    """
+    match type:
+        case 'info':
+            alert_class = 'alert-info'
+            text_class = 'text-info'
+            icon_class = 'fa fa-info-circle'
+        case 'warning':
+            alert_class = 'alert-warning'
+            text_class = 'text-warning'
+            icon_class = 'fa fa-exclamation-triangle'
+        case 'danger':
+            alert_class = 'alert-danger'
+            text_class = 'text-danger'
+            icon_class = 'fa fa-times-circle'
+        case 'success':
+            alert_class = 'alert-success'
+            text_class = 'text-success'
+            icon_class = 'fa fa-check-circle'
+        case _:
+            alert_class = 'alert-info'
+            text_class = 'text-info'
+            icon_class = 'fa fa-info-circle'
+    context = {
+        'slot_content': content,
+        'alert_class': alert_class,
+        'text_class': text_class,
+        'icon_class': icon_class,
+    }
+    return render_to_string('django_sample_components/components/simple_alert.html', context)

django_sample_components/urls.py ADDED Viewed

@@ -0,0 +1,11 @@
+from django.urls import path
+from .views import Alert, Greeting, Home
+app_name = 'django_sample_components'
+urlpatterns = [
+    path('', Home.as_view(), name='home'),
+    path('greeting/', Greeting.as_view(), name='greeting'),
+    path('alert/', Alert.as_view(), name='alert'),
+]

django_sample_components/views.py ADDED Viewed

@@ -0,0 +1,22 @@
+from django.conf import settings
+from django.shortcuts import render
+from django.views import View
+class Home(View):
+    def get(self, request):
+        context = {
+            'url_pypi': settings.URL_PYPI,
+            'url_github': settings.URL_GITHUB,
+        }
+        return render(request, 'django_sample_components/pages/home.html', context)
+class Greeting(View):
+    def get(self, request):
+        return render(request, 'django_sample_components/pages/greeting.html')
+class Alert(View):
+    def get(self, request):
+        return render(request, 'django_sample_components/pages/alert.html')

django_sample_components-0.1.0.dist-info/METADATA ADDED Viewed

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: django-sample-components
+Version: 0.1.0
+Summary: A handy collection of reusable Django UI components, allowing me to share and integrate elements efficiently across various projects.
+License: MIT
+License-File: LICENSE
+Author: Gustavo Rizzo S M de Albuquerque
+Author-email: grizzo.albu@gmail.com
+Requires-Python: >=3.14,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: django (>=5.2.7,<6.0.0)
+Description-Content-Type: text/markdown
+# django-sample-components 🚀
+[![PyPI](https://img.shields.io/pypi/v/django-sample-components.svg)](https://pypi.org/project/django-sample-components/)
+> This project is a test for creating a Django library. 🧩
+## Installation 📦
+You can install the library using pip or poetry:
+```bash
+pip install django-sample-components
+```
+or
+```bash
+poetry add django-sample-components
+```
+## Configuration ⚙️
+Add `django_sample_components` to the `INSTALLED_APPS` list in your `settings.py`:
+```python
+INSTALLED_APPS = [
+    # ... other apps ...
+    'django_sample_components',
+]
+```
+## Migrations 🗄️
+After installing and configuring, run the following commands:
+```bash
+python manage.py makemigrations
+python manage.py migrate
+```
+🎉 Done! Your Django library is installed and ready to use.
+## Running locally as a developer 🖥️
+To run the Django project locally during development, follow the steps below:
+```bash
+git clone https://github.com/GustavoRizzo/django-sample-components.git
+cd django-sample-components
+poetry install
+cd demo_project
+pip install -e ..
+poetry run ./manage.py runserver
+```
+### Tests 🧪
+To run the tests, use the command below inside the `demo_project` directory:
+```bash
+poetry run ./manage.py test
+```
+## Updating and publishing the library 🚢
+To update the version, build, and publish your library, use the commands below:
+```bash
+poetry version patch  # to bump the version (e.g.: 0.1.0 → 0.1.1)
+poetry build
+tar -tzf dist/*.tar.gz | head -20  # to see the files inside the package
+poetry publish
+```

django_sample_components-0.1.0.dist-info/RECORD ADDED Viewed

@@ -0,0 +1,24 @@
+django_sample_components/__init__.py,sha256=C_GfzpVLzI8cd065ccOmUeU-gJ7IMzsYhiUaz0tSfUs,153
+django_sample_components/admin.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_sample_components/apps.py,sha256=Y4l3Dx3smnEC5yuvWFtvJIcZuipXWNt_mcNkmuaRwUk,220
+django_sample_components/models.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_sample_components/static/css/style.css,sha256=5xWTwmVWM4I-8rlHOsngK0WKFHX7YJgE6f5B3YH0UUQ,295
+django_sample_components/static/js/main.js,sha256=DycjxouQQCdfuOkbAyfoLHIvFfxtfNw2qMWG8Osh1bk,30
+django_sample_components/templates/django_sample_components/components/simple_alert.html,sha256=VobcDLKnf2olrres_hMsYYSG1mfW2LxVVoLKs43frok,662
+django_sample_components/templates/django_sample_components/pages/alert.html,sha256=skaLrceKA_LF2NFQJZifIV1NazpiVetoXWP-g5jUEtg,818
+django_sample_components/templates/django_sample_components/pages/greeting.html,sha256=YMbalY1pl_-6rDnLZV56VOc5aa3NOaqqODW8T-jHAXY,191
+django_sample_components/templates/django_sample_components/pages/home.html,sha256=14uFrCnpyfR8ymHUxoRm3kaeGOZdREwBS3CKNRCwTn0,434
+django_sample_components/templates/django_sample_components/pages/master.html,sha256=xr7VW2ALU66NubFf504xkjtZOYBB3GhEB0M6MvAJaM8,1592
+django_sample_components/templates/django_sample_components/partials/menu.html,sha256=zDSC6NwfDjeT1tBkhKmT3w5SQqF5XN6NxXawnKymLAs,244
+django_sample_components/templatetags/__init__.py,sha256=ieX81f0m9BgO6QANOF66q5xM7SB_Lzk93mdZg72UNMk,222
+django_sample_components/templatetags/sample_tags/__init__.py,sha256=Wedfy5LN6i5OveiSGvLj2hlRXvLu0CPJzVLIdi9DLMc,397
+django_sample_components/templatetags/sample_tags/greeting.py,sha256=cBJ_fdNtI7vZ7RLSJtJv3CWMl2Awzxz1KCrcE9Nay8c,49
+django_sample_components/templatetags/sample_tags/shout.py,sha256=1Cm_yN-lXsW_2Jgka4ZT6f88gXOBgupoc2VeLgA4bLM,217
+django_sample_components/templatetags/sample_tags/show_today_timestamp.py,sha256=j33yjxtTe1fvyo9nCwl_IE9eiaqtXtjUOOtPJMWiZCE,75
+django_sample_components/templatetags/sample_tags/simple_alert.py,sha256=cVYgQqrmXIQIUW5bVxw7_3DaZTMHUSV2jV5UIUzi2c0,1331
+django_sample_components/urls.py,sha256=ASNS1_FChiQIwAkrlZBczSRqE98s3wrej-zzaJVuLgE,283
+django_sample_components/views.py,sha256=OAlRx8OuU8nkRkvZhqATN7sxc21bAkWASPI3NQq7vjE,607
+django_sample_components-0.1.0.dist-info/METADATA,sha256=d-j6uzz0C12dTMNxhURO8h9XCjAvsPxXYrCLy5Cjj98,2163
+django_sample_components-0.1.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+django_sample_components-0.1.0.dist-info/licenses/LICENSE,sha256=omeibtobS2xYBqFCu-WthJTVP4jrOP2Viv7ofbh-Rig,1082
+django_sample_components-0.1.0.dist-info/RECORD,,

django_sample_components-0.1.0.dist-info/WHEEL ADDED Viewed

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any

django_sample_components-0.1.0.dist-info/licenses/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2025 Gustavo Rizzo Albuquerque
+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.