micro-sidebar 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

micro_sidebar-1.1.0.dist-info/LICENSE

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

micro_sidebar-1.1.0.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: micro-sidebar
+Version: 1.1.0
+Summary: A Reusable RTL Django Sidebar App
+Home-page: https://github.com/debeski/micro-sidebar
+Author: DeBeski
+Author-email: DeBeski <debeski1@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/debeski/micro-sidebar
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5
+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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django (>=5.1)
+
+# Micro Sidebar - A Reusable RTL Django Sidebar App
+
+[![PyPI version](https://badge.fury.io/py/micro-sidebar.svg)](https://pypi.org/project/micro-sidebar/)
+
+**RTL** lightweight, reusable django app that provides a dynamic sidebar for your django projects.
+
+## Requirements
+
+-   **Django**: >= 5.1
+-   **Bootstrap**: 5 (Required for consistent styling)
+
+## Installation
+
+1.  **Install:**
+    ```bash
+    pip install micro-sidebar
+    # OR
+    pip install git+https://github.com/debeski/micro-sidebar.git
+    ```
+
+2.  **Add to `INSTALLED_APPS`:**
+    In your `settings.py`:
+    ```python
+    INSTALLED_APPS = [
+        ...
+        'sidebar',
+        ...
+    ]
+    ```
+
+3.  **Configure URLs:**
+    In your project's `urls.py`:
+    ```python
+    from django.urls import path, include
+
+    urlpatterns = [
+        ...
+        path('sidebar/', include('sidebar.urls')),
+        ...
+    ]
+    ```
+
+## Customization
+
+### Override Default Menu
+The sidebar uses a block-based template system. To define your own menu items:
+
+1. Create a new template (e.g., `templates/sidebar_menu.html`).
+2. Extend `sidebar/main.html`.
+3. Override the `{% block items %}`.
+
+**Example `sidebar_menu.html`:**
+```html
+{% extends "sidebar/main.html" %}
+
+{% block items %}
+<a href="{% url 'home' %}" class="list-group-item list-group-item-action">
+    <i class="bi bi-house me-2" style="font-size: 24px;"></i>
+    <span>Home</span>
+</a>
+<a href="{% url 'settings' %}" class="list-group-item list-group-item-action">
+    <i class="bi bi-gear me-2" style="font-size: 24px;"></i>
+    <span>Settings</span>
+</a>
+{% endblock %}
+```
+
+Then, include your custom template in `base.html`:
+```html
+{% include "sidebar_menu.html" %}
+```
+
+### Positioning
+The sidebar is sticky by default. If your app has a top navigation bar (titlebar), the sidebar will automatically adjust its position below it on small screens. If no titlebar is detected, it will stick to the top of the viewport.
+
+## RTL / LTR Support
+This sidebar is primarily designed for **RTL (Right-to-Left)** interfaces (e.g., Arabic). 
+While it may theoretically work in LTR environments if standard Bootstrap files are used instead of RTL versions, this has **not been fully tested**. 
+> *Future updates are planned to support dynamic language switching between RTL and LTR.*
+
+## Version History
+
+| Version | Changes |
+| :--- | :--- |
+| **v1.0.0** | Initial Release. |
+| **v1.0.1** | Fixed titlebar positioning bug causing overlap/gaps. |
+| **v1.0.2** | Improved documentation clarity and added usage instructions. |
+| **v1.1.0** | Renamed `content.html` to `main.html` for clarity. Refactored to use `{% block items %}` for easier extension. |

micro_sidebar-1.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+sidebar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sidebar/apps.py,sha256=4UjKXHoBGKRLxpC9AY6eaq8YZx8unirUz_8u-IrlfVQ,145
+sidebar/urls.py,sha256=UL_9e1RLNMxZXkah65m7GRU1dbViZRGeNPBIiSZpOYg,142
+sidebar/views.py,sha256=MebyJ1ZiylSOPESXFkkQ8QTg-ClrkJn-oYLN6KrcgiM,418
+sidebar/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sidebar/static/sidebar/sidebar.css,sha256=aEbc4yPFaQBpMoYnJi575u077pHzej7FLFP8kgRnfBk,2105
+sidebar/static/sidebar/sidebar.js,sha256=jLspMcoRDpsw_KpIegGwSL-FRi_uz_8pQ95zDXMnTZ0,6221
+sidebar/templates/sidebar/main.html,sha256=8dhxllfL40advQ6z2UlqH_wf3Nnf7ilexukoG7VQoek,1363
+micro_sidebar-1.1.0.dist-info/LICENSE,sha256=Fco89ULLSSxKkC2KKnx57SaT0R7WOkZfuk8IYcGiN50,1063
+micro_sidebar-1.1.0.dist-info/METADATA,sha256=nlAXd6VHbs4FwddvAZmSxP_0SP6JgACUygmByl3J_mw,3639
+micro_sidebar-1.1.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+micro_sidebar-1.1.0.dist-info/top_level.txt,sha256=ih69sjMhU1wOB9HzUV90yEY98aiPuGhzPBBBE-YtJ3w,8
+micro_sidebar-1.1.0.dist-info/RECORD,,

{micro_sidebar-1.0.1.dist-info → micro_sidebar-1.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: bdist_wheel (0.40.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sidebar/templates/sidebar/{content.html → main.html}

@@ -1,6 +1,6 @@
 {% load static %}
-<link rel="stylesheet" href="{% static 'sidebar/style.css' %}">
-<script src="{% static 'sidebar/js/sidebar.js' %}" nonce="{{ request.csp_nonce }}" defer></script>
+<link rel="stylesheet" href="{% static 'sidebar/sidebar.css' %}">
+<script src="{% static 'sidebar/sidebar.js' %}" nonce="{{ request.csp_nonce }}" defer></script>
 <!-- Ghost Sidebar for small screens layout stability -->
 <div class="sidebar-ghost"></div>
 
@@ -10,15 +10,16 @@
      data-toggle-url="{% url 'toggle_sidebar' %}"
      data-session-collapsed="{{ request.session.sidebarCollapsed|yesno:'true,false' }}">
     <div class="list-group flex-shrink-0">
+        {% block items %}
         
         <!-- DEFAULT CONTENT / INSTRUCTIONS -->
         <div class="p-3 text-center text-muted">
             <i class="bi bi-info-circle mb-2" style="font-size: 24px;"></i>
             <p class="small">
                 <strong>Default Sidebar</strong><br>
-                To customize this menu, create a file at:<br>
-                <code>templates/sidebar/content.html</code><br>
-                in your Django project.
+                To customize this menu, create a template extending:<br>
+                <code>sidebar/main.html</code><br>
+                and override the <code>items</code> block.
             </p>
         </div>
 
@@ -27,5 +28,6 @@
             <span>Example Home</span>
         </a>
         
+        {% endblock %}
     </div>
 </div>

micro_sidebar-1.0.1.dist-info/METADATA

@@ -1,98 +0,0 @@
-Metadata-Version: 2.4
-Name: micro_sidebar
-Version: 1.0.1
-Summary: A reusable Django sidebar for Web Apps
-Home-page: https://github.com/debeski/micro-sidebar
-Author: DeBeski
-Author-email: DeBeski <debeski1@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/debeski/micro-sidebar
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 5
-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: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: Django>=5.1
-Dynamic: author
-Dynamic: home-page
-Dynamic: requires-python
-
-# Micro Sidebar
-
-A reusable Django sidebar app for Web Apps.
-
-## Requirements
-
--   **Django**: >= 5.1
--   **Bootstrap**: 5 (Required for consistent styling)
-
-## Installation
-
-1.  **Install the package:**
-    ```bash
-    pip install micro-sidebar
-    ```
-
-2.  **Add to `INSTALLED_APPS`:**
-    In your `settings.py`:
-    ```python
-    INSTALLED_APPS = [
-        ...
-        'sidebar',
-        ...
-    ]
-    ```
-
-3.  **Configure URLs:**
-    In your project's `urls.py`:
-    ```python
-    from django.urls import path, include
-
-    urlpatterns = [
-        ...
-        path('sidebar/', include('sidebar.urls')),
-        ...
-    ]
-    ```
-
-4.  **Add to your Base Template:**
-    In your `base.html` (or equivalent), include the sidebar. It is designed to sit on the left (or right in RTL) of your main content. 
-    
-    Example structure using Flexbox:
-    ```html
-    <body>
-        <div class="d-flex">
-            <!-- Sidebar -->
-            {% include "sidebar/content.html" %}
-
-            <!-- Main Content -->
-            <div class="flex-grow-1">
-                {% block content %}{% endblock %}
-            </div>
-        </div>
-        
-        <!-- Bootstrap JS (Required) -->
-        <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
-    </body>
-    ```
-
-## Customization
-
-### Overriding Content
-The sidebar comes with a default template. To customize the links and content, create a file named `content.html` inside `templates/sidebar/` in your project's `templates` directory.
-
-**Path:** `your_project/templates/sidebar/content.html`
-
-The default sidebar logic expects specific classes like `.list-group-item` and `.accordion-item` for the collapsible features to work correctly with the provided JS.
-
-### Positioning
-The sidebar is sticky by default. If your app has a top navigation bar (titlebar), the sidebar will automatically adjust its position below it on small screens. If no titlebar is detected, it will stick to the top of the viewport.

micro_sidebar-1.0.1.dist-info/RECORD

@@ -1,12 +0,0 @@
-sidebar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sidebar/apps.py,sha256=4UjKXHoBGKRLxpC9AY6eaq8YZx8unirUz_8u-IrlfVQ,145
-sidebar/urls.py,sha256=UL_9e1RLNMxZXkah65m7GRU1dbViZRGeNPBIiSZpOYg,142
-sidebar/views.py,sha256=MebyJ1ZiylSOPESXFkkQ8QTg-ClrkJn-oYLN6KrcgiM,418
-sidebar/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sidebar/static/sidebar/style.css,sha256=aEbc4yPFaQBpMoYnJi575u077pHzej7FLFP8kgRnfBk,2105
-sidebar/static/sidebar/js/sidebar.js,sha256=jLspMcoRDpsw_KpIegGwSL-FRi_uz_8pQ95zDXMnTZ0,6221
-sidebar/templates/sidebar/content.html,sha256=hSqgzvuWZRxlUN1-zC-Oovppd_rbnCylxQmfRdGIbhY,1298
-micro_sidebar-1.0.1.dist-info/METADATA,sha256=8qel9NqaW4TW5VmQOmtV4LzGqZ6VyBGsjlKmfF70RRI,3025
-micro_sidebar-1.0.1.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-micro_sidebar-1.0.1.dist-info/top_level.txt,sha256=ih69sjMhU1wOB9HzUV90yEY98aiPuGhzPBBBE-YtJ3w,8
-micro_sidebar-1.0.1.dist-info/RECORD,,