micro-sidebar 1.0.1__tar.gz → 1.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 (23) hide show
  1. micro_sidebar-1.1.0/LICENSE +21 -0
  2. micro_sidebar-1.1.0/PKG-INFO +114 -0
  3. micro_sidebar-1.1.0/README.md +88 -0
  4. micro_sidebar-1.1.0/micro_sidebar.egg-info/PKG-INFO +114 -0
  5. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/micro_sidebar.egg-info/SOURCES.txt +4 -3
  6. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/pyproject.toml +9 -3
  7. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/setup.py +2 -2
  8. micro_sidebar-1.0.1/sidebar/templates/sidebar/content.html → micro_sidebar-1.1.0/sidebar/templates/sidebar/main.html +7 -5
  9. micro_sidebar-1.0.1/PKG-INFO +0 -98
  10. micro_sidebar-1.0.1/README.md +0 -70
  11. micro_sidebar-1.0.1/micro_sidebar.egg-info/PKG-INFO +0 -98
  12. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/MANIFEST.in +0 -0
  13. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/micro_sidebar.egg-info/dependency_links.txt +0 -0
  14. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/micro_sidebar.egg-info/requires.txt +0 -0
  15. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/micro_sidebar.egg-info/top_level.txt +0 -0
  16. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/setup.cfg +0 -0
  17. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/sidebar/__init__.py +0 -0
  18. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/sidebar/apps.py +0 -0
  19. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/sidebar/migrations/__init__.py +0 -0
  20. /micro_sidebar-1.0.1/sidebar/static/sidebar/style.css → /micro_sidebar-1.1.0/sidebar/static/sidebar/sidebar.css +0 -0
  21. {micro_sidebar-1.0.1/sidebar/static/sidebar/js → micro_sidebar-1.1.0/sidebar/static/sidebar}/sidebar.js +0 -0
  22. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/sidebar/urls.py +0 -0
  23. {micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/sidebar/views.py +0 -0
micro_sidebar-1.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 DeBeski
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.
micro_sidebar-1.1.0/PKG-INFO ADDED
@@ -0,0 +1,114 @@
1
+ Metadata-Version: 2.1
2
+ Name: micro_sidebar
3
+ Version: 1.1.0
4
+ Summary: A Reusable RTL Django Sidebar App
5
+ Home-page: https://github.com/debeski/micro-sidebar
6
+ Author: DeBeski
7
+ Author-email: DeBeski <debeski1@gmail.com>
8
+ License: MIT
9
+ Project-URL: Homepage, https://github.com/debeski/micro-sidebar
10
+ Classifier: Framework :: Django
11
+ Classifier: Framework :: Django :: 5
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: License :: OSI Approved :: MIT License
21
+ Classifier: Operating System :: OS Independent
22
+ Requires-Python: >=3.9
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: Django>=5.1
26
+
27
+ # Micro Sidebar - A Reusable RTL Django Sidebar App
28
+
29
+ [![PyPI version](https://badge.fury.io/py/micro-sidebar.svg)](https://pypi.org/project/micro-sidebar/)
30
+
31
+ **RTL** lightweight, reusable django app that provides a dynamic sidebar for your django projects.
32
+
33
+ ## Requirements
34
+
35
+ - **Django**: >= 5.1
36
+ - **Bootstrap**: 5 (Required for consistent styling)
37
+
38
+ ## Installation
39
+
40
+ 1. **Install:**
41
+ ```bash
42
+ pip install micro-sidebar
43
+ # OR
44
+ pip install git+https://github.com/debeski/micro-sidebar.git
45
+ ```
46
+
47
+ 2. **Add to `INSTALLED_APPS`:**
48
+ In your `settings.py`:
49
+ ```python
50
+ INSTALLED_APPS = [
51
+ ...
52
+ 'sidebar',
53
+ ...
54
+ ]
55
+ ```
56
+
57
+ 3. **Configure URLs:**
58
+ In your project's `urls.py`:
59
+ ```python
60
+ from django.urls import path, include
61
+
62
+ urlpatterns = [
63
+ ...
64
+ path('sidebar/', include('sidebar.urls')),
65
+ ...
66
+ ]
67
+ ```
68
+
69
+ ## Customization
70
+
71
+ ### Override Default Menu
72
+ The sidebar uses a block-based template system. To define your own menu items:
73
+
74
+ 1. Create a new template (e.g., `templates/sidebar_menu.html`).
75
+ 2. Extend `sidebar/main.html`.
76
+ 3. Override the `{% block items %}`.
77
+
78
+ **Example `sidebar_menu.html`:**
79
+ ```html
80
+ {% extends "sidebar/main.html" %}
81
+
82
+ {% block items %}
83
+ <a href="{% url 'home' %}" class="list-group-item list-group-item-action">
84
+ <i class="bi bi-house me-2" style="font-size: 24px;"></i>
85
+ <span>Home</span>
86
+ </a>
87
+ <a href="{% url 'settings' %}" class="list-group-item list-group-item-action">
88
+ <i class="bi bi-gear me-2" style="font-size: 24px;"></i>
89
+ <span>Settings</span>
90
+ </a>
91
+ {% endblock %}
92
+ ```
93
+
94
+ Then, include your custom template in `base.html`:
95
+ ```html
96
+ {% include "sidebar_menu.html" %}
97
+ ```
98
+
99
+ ### Positioning
100
+ 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.
101
+
102
+ ## RTL / LTR Support
103
+ This sidebar is primarily designed for **RTL (Right-to-Left)** interfaces (e.g., Arabic).
104
+ While it may theoretically work in LTR environments if standard Bootstrap files are used instead of RTL versions, this has **not been fully tested**.
105
+ > *Future updates are planned to support dynamic language switching between RTL and LTR.*
106
+
107
+ ## Version History
108
+
109
+ | Version | Changes |
110
+ | :--- | :--- |
111
+ | **v1.0.0** | Initial Release. |
112
+ | **v1.0.1** | Fixed titlebar positioning bug causing overlap/gaps. |
113
+ | **v1.0.2** | Improved documentation clarity and added usage instructions. |
114
+ | **v1.1.0** | Renamed `content.html` to `main.html` for clarity. Refactored to use `{% block items %}` for easier extension. |
micro_sidebar-1.1.0/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # Micro Sidebar - A Reusable RTL Django Sidebar App
2
+
3
+ [![PyPI version](https://badge.fury.io/py/micro-sidebar.svg)](https://pypi.org/project/micro-sidebar/)
4
+
5
+ **RTL** lightweight, reusable django app that provides a dynamic sidebar for your django projects.
6
+
7
+ ## Requirements
8
+
9
+ - **Django**: >= 5.1
10
+ - **Bootstrap**: 5 (Required for consistent styling)
11
+
12
+ ## Installation
13
+
14
+ 1. **Install:**
15
+ ```bash
16
+ pip install micro-sidebar
17
+ # OR
18
+ pip install git+https://github.com/debeski/micro-sidebar.git
19
+ ```
20
+
21
+ 2. **Add to `INSTALLED_APPS`:**
22
+ In your `settings.py`:
23
+ ```python
24
+ INSTALLED_APPS = [
25
+ ...
26
+ 'sidebar',
27
+ ...
28
+ ]
29
+ ```
30
+
31
+ 3. **Configure URLs:**
32
+ In your project's `urls.py`:
33
+ ```python
34
+ from django.urls import path, include
35
+
36
+ urlpatterns = [
37
+ ...
38
+ path('sidebar/', include('sidebar.urls')),
39
+ ...
40
+ ]
41
+ ```
42
+
43
+ ## Customization
44
+
45
+ ### Override Default Menu
46
+ The sidebar uses a block-based template system. To define your own menu items:
47
+
48
+ 1. Create a new template (e.g., `templates/sidebar_menu.html`).
49
+ 2. Extend `sidebar/main.html`.
50
+ 3. Override the `{% block items %}`.
51
+
52
+ **Example `sidebar_menu.html`:**
53
+ ```html
54
+ {% extends "sidebar/main.html" %}
55
+
56
+ {% block items %}
57
+ <a href="{% url 'home' %}" class="list-group-item list-group-item-action">
58
+ <i class="bi bi-house me-2" style="font-size: 24px;"></i>
59
+ <span>Home</span>
60
+ </a>
61
+ <a href="{% url 'settings' %}" class="list-group-item list-group-item-action">
62
+ <i class="bi bi-gear me-2" style="font-size: 24px;"></i>
63
+ <span>Settings</span>
64
+ </a>
65
+ {% endblock %}
66
+ ```
67
+
68
+ Then, include your custom template in `base.html`:
69
+ ```html
70
+ {% include "sidebar_menu.html" %}
71
+ ```
72
+
73
+ ### Positioning
74
+ 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.
75
+
76
+ ## RTL / LTR Support
77
+ This sidebar is primarily designed for **RTL (Right-to-Left)** interfaces (e.g., Arabic).
78
+ While it may theoretically work in LTR environments if standard Bootstrap files are used instead of RTL versions, this has **not been fully tested**.
79
+ > *Future updates are planned to support dynamic language switching between RTL and LTR.*
80
+
81
+ ## Version History
82
+
83
+ | Version | Changes |
84
+ | :--- | :--- |
85
+ | **v1.0.0** | Initial Release. |
86
+ | **v1.0.1** | Fixed titlebar positioning bug causing overlap/gaps. |
87
+ | **v1.0.2** | Improved documentation clarity and added usage instructions. |
88
+ | **v1.1.0** | Renamed `content.html` to `main.html` for clarity. Refactored to use `{% block items %}` for easier extension. |
micro_sidebar-1.1.0/micro_sidebar.egg-info/PKG-INFO ADDED
@@ -0,0 +1,114 @@
1
+ Metadata-Version: 2.1
2
+ Name: micro-sidebar
3
+ Version: 1.1.0
4
+ Summary: A Reusable RTL Django Sidebar App
5
+ Home-page: https://github.com/debeski/micro-sidebar
6
+ Author: DeBeski
7
+ Author-email: DeBeski <debeski1@gmail.com>
8
+ License: MIT
9
+ Project-URL: Homepage, https://github.com/debeski/micro-sidebar
10
+ Classifier: Framework :: Django
11
+ Classifier: Framework :: Django :: 5
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: License :: OSI Approved :: MIT License
21
+ Classifier: Operating System :: OS Independent
22
+ Requires-Python: >=3.9
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: Django>=5.1
26
+
27
+ # Micro Sidebar - A Reusable RTL Django Sidebar App
28
+
29
+ [![PyPI version](https://badge.fury.io/py/micro-sidebar.svg)](https://pypi.org/project/micro-sidebar/)
30
+
31
+ **RTL** lightweight, reusable django app that provides a dynamic sidebar for your django projects.
32
+
33
+ ## Requirements
34
+
35
+ - **Django**: >= 5.1
36
+ - **Bootstrap**: 5 (Required for consistent styling)
37
+
38
+ ## Installation
39
+
40
+ 1. **Install:**
41
+ ```bash
42
+ pip install micro-sidebar
43
+ # OR
44
+ pip install git+https://github.com/debeski/micro-sidebar.git
45
+ ```
46
+
47
+ 2. **Add to `INSTALLED_APPS`:**
48
+ In your `settings.py`:
49
+ ```python
50
+ INSTALLED_APPS = [
51
+ ...
52
+ 'sidebar',
53
+ ...
54
+ ]
55
+ ```
56
+
57
+ 3. **Configure URLs:**
58
+ In your project's `urls.py`:
59
+ ```python
60
+ from django.urls import path, include
61
+
62
+ urlpatterns = [
63
+ ...
64
+ path('sidebar/', include('sidebar.urls')),
65
+ ...
66
+ ]
67
+ ```
68
+
69
+ ## Customization
70
+
71
+ ### Override Default Menu
72
+ The sidebar uses a block-based template system. To define your own menu items:
73
+
74
+ 1. Create a new template (e.g., `templates/sidebar_menu.html`).
75
+ 2. Extend `sidebar/main.html`.
76
+ 3. Override the `{% block items %}`.
77
+
78
+ **Example `sidebar_menu.html`:**
79
+ ```html
80
+ {% extends "sidebar/main.html" %}
81
+
82
+ {% block items %}
83
+ <a href="{% url 'home' %}" class="list-group-item list-group-item-action">
84
+ <i class="bi bi-house me-2" style="font-size: 24px;"></i>
85
+ <span>Home</span>
86
+ </a>
87
+ <a href="{% url 'settings' %}" class="list-group-item list-group-item-action">
88
+ <i class="bi bi-gear me-2" style="font-size: 24px;"></i>
89
+ <span>Settings</span>
90
+ </a>
91
+ {% endblock %}
92
+ ```
93
+
94
+ Then, include your custom template in `base.html`:
95
+ ```html
96
+ {% include "sidebar_menu.html" %}
97
+ ```
98
+
99
+ ### Positioning
100
+ 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.
101
+
102
+ ## RTL / LTR Support
103
+ This sidebar is primarily designed for **RTL (Right-to-Left)** interfaces (e.g., Arabic).
104
+ While it may theoretically work in LTR environments if standard Bootstrap files are used instead of RTL versions, this has **not been fully tested**.
105
+ > *Future updates are planned to support dynamic language switching between RTL and LTR.*
106
+
107
+ ## Version History
108
+
109
+ | Version | Changes |
110
+ | :--- | :--- |
111
+ | **v1.0.0** | Initial Release. |
112
+ | **v1.0.1** | Fixed titlebar positioning bug causing overlap/gaps. |
113
+ | **v1.0.2** | Improved documentation clarity and added usage instructions. |
114
+ | **v1.1.0** | Renamed `content.html` to `main.html` for clarity. Refactored to use `{% block items %}` for easier extension. |
{micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/micro_sidebar.egg-info/SOURCES.txt RENAMED
@@ -1,3 +1,4 @@
1
+ LICENSE
1
2
  MANIFEST.in
2
3
  README.md
3
4
  pyproject.toml
@@ -12,6 +13,6 @@ sidebar/apps.py
12
13
  sidebar/urls.py
13
14
  sidebar/views.py
14
15
  sidebar/migrations/__init__.py
15
- sidebar/static/sidebar/style.css
16
- sidebar/static/sidebar/js/sidebar.js
17
- sidebar/templates/sidebar/content.html
16
+ sidebar/static/sidebar/sidebar.css
17
+ sidebar/static/sidebar/sidebar.js
18
+ sidebar/templates/sidebar/main.html
{micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/pyproject.toml RENAMED
@@ -1,11 +1,14 @@
1
1
  [build-system]
2
- requires = ["setuptools>=61.0"]
2
+ requires = [
3
+ "setuptools<69",
4
+ "wheel<0.41"
5
+ ]
3
6
  build-backend = "setuptools.build_meta"
4
7
 
5
8
  [project]
6
9
  name = "micro_sidebar"
7
- version = "1.0.1"
8
- description = "A reusable Django sidebar for Web Apps"
10
+ version = "1.1.0"
11
+ description = "A Reusable RTL Django Sidebar App"
9
12
  readme = "README.md"
10
13
  requires-python = ">=3.9"
11
14
  license = {text = "MIT"}
@@ -36,3 +39,6 @@ Homepage = "https://github.com/debeski/micro-sidebar"
36
39
  [tool.setuptools.packages.find]
37
40
  where = ["."]
38
41
  include = ["sidebar*"]
42
+
43
+ [tool.setuptools]
44
+ include-package-data = true
{micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/setup.py RENAMED
@@ -2,10 +2,10 @@ from setuptools import setup, find_packages
2
2
 
3
3
  setup(
4
4
  name="micro_sidebar",
5
- version="1.0.1",
5
+ version="1.1.0",
6
6
  author="DeBeski",
7
7
  author_email="debeski1@gmail.com",
8
- description="A reusable Django sidebar for Web Apps",
8
+ description="A Reusable RTL Django Sidebar App",
9
9
  long_description=open('README.md').read() if open('README.md') else '',
10
10
  long_description_content_type="text/markdown",
11
11
  url="https://github.com/debeski/micro-sidebar",
micro_sidebar-1.0.1/sidebar/templates/sidebar/content.html → micro_sidebar-1.1.0/sidebar/templates/sidebar/main.html RENAMED
@@ -1,6 +1,6 @@
1
1
  {% load static %}
2
- <link rel="stylesheet" href="{% static 'sidebar/style.css' %}">
3
- <script src="{% static 'sidebar/js/sidebar.js' %}" nonce="{{ request.csp_nonce }}" defer></script>
2
+ <link rel="stylesheet" href="{% static 'sidebar/sidebar.css' %}">
3
+ <script src="{% static 'sidebar/sidebar.js' %}" nonce="{{ request.csp_nonce }}" defer></script>
4
4
  <!-- Ghost Sidebar for small screens layout stability -->
5
5
  <div class="sidebar-ghost"></div>
6
6
 
@@ -10,15 +10,16 @@
10
10
  data-toggle-url="{% url 'toggle_sidebar' %}"
11
11
  data-session-collapsed="{{ request.session.sidebarCollapsed|yesno:'true,false' }}">
12
12
  <div class="list-group flex-shrink-0">
13
+ {% block items %}
13
14
 
14
15
  <!-- DEFAULT CONTENT / INSTRUCTIONS -->
15
16
  <div class="p-3 text-center text-muted">
16
17
  <i class="bi bi-info-circle mb-2" style="font-size: 24px;"></i>
17
18
  <p class="small">
18
19
  <strong>Default Sidebar</strong><br>
19
- To customize this menu, create a file at:<br>
20
- <code>templates/sidebar/content.html</code><br>
21
- in your Django project.
20
+ To customize this menu, create a template extending:<br>
21
+ <code>sidebar/main.html</code><br>
22
+ and override the <code>items</code> block.
22
23
  </p>
23
24
  </div>
24
25
 
@@ -27,5 +28,6 @@
27
28
  <span>Example Home</span>
28
29
  </a>
29
30
 
31
+ {% endblock %}
30
32
  </div>
31
33
  </div>
micro_sidebar-1.0.1/PKG-INFO DELETED
@@ -1,98 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: micro_sidebar
3
- Version: 1.0.1
4
- Summary: A reusable Django sidebar for Web Apps
5
- Home-page: https://github.com/debeski/micro-sidebar
6
- Author: DeBeski
7
- Author-email: DeBeski <debeski1@gmail.com>
8
- License: MIT
9
- Project-URL: Homepage, https://github.com/debeski/micro-sidebar
10
- Classifier: Framework :: Django
11
- Classifier: Framework :: Django :: 5
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.8
14
- Classifier: Programming Language :: Python :: 3.9
15
- Classifier: Programming Language :: Python :: 3.10
16
- Classifier: Programming Language :: Python :: 3.11
17
- Classifier: Programming Language :: Python :: 3.12
18
- Classifier: Programming Language :: Python :: 3.13
19
- Classifier: Programming Language :: Python :: 3.14
20
- Classifier: License :: OSI Approved :: MIT License
21
- Classifier: Operating System :: OS Independent
22
- Requires-Python: >=3.9
23
- Description-Content-Type: text/markdown
24
- Requires-Dist: Django>=5.1
25
- Dynamic: author
26
- Dynamic: home-page
27
- Dynamic: requires-python
28
-
29
- # Micro Sidebar
30
-
31
- A reusable Django sidebar app for Web Apps.
32
-
33
- ## Requirements
34
-
35
- - **Django**: >= 5.1
36
- - **Bootstrap**: 5 (Required for consistent styling)
37
-
38
- ## Installation
39
-
40
- 1. **Install the package:**
41
- ```bash
42
- pip install micro-sidebar
43
- ```
44
-
45
- 2. **Add to `INSTALLED_APPS`:**
46
- In your `settings.py`:
47
- ```python
48
- INSTALLED_APPS = [
49
- ...
50
- 'sidebar',
51
- ...
52
- ]
53
- ```
54
-
55
- 3. **Configure URLs:**
56
- In your project's `urls.py`:
57
- ```python
58
- from django.urls import path, include
59
-
60
- urlpatterns = [
61
- ...
62
- path('sidebar/', include('sidebar.urls')),
63
- ...
64
- ]
65
- ```
66
-
67
- 4. **Add to your Base Template:**
68
- 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.
69
-
70
- Example structure using Flexbox:
71
- ```html
72
- <body>
73
- <div class="d-flex">
74
- <!-- Sidebar -->
75
- {% include "sidebar/content.html" %}
76
-
77
- <!-- Main Content -->
78
- <div class="flex-grow-1">
79
- {% block content %}{% endblock %}
80
- </div>
81
- </div>
82
-
83
- <!-- Bootstrap JS (Required) -->
84
- <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
85
- </body>
86
- ```
87
-
88
- ## Customization
89
-
90
- ### Overriding Content
91
- 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.
92
-
93
- **Path:** `your_project/templates/sidebar/content.html`
94
-
95
- 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.
96
-
97
- ### Positioning
98
- 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/README.md DELETED
@@ -1,70 +0,0 @@
1
- # Micro Sidebar
2
-
3
- A reusable Django sidebar app for Web Apps.
4
-
5
- ## Requirements
6
-
7
- - **Django**: >= 5.1
8
- - **Bootstrap**: 5 (Required for consistent styling)
9
-
10
- ## Installation
11
-
12
- 1. **Install the package:**
13
- ```bash
14
- pip install micro-sidebar
15
- ```
16
-
17
- 2. **Add to `INSTALLED_APPS`:**
18
- In your `settings.py`:
19
- ```python
20
- INSTALLED_APPS = [
21
- ...
22
- 'sidebar',
23
- ...
24
- ]
25
- ```
26
-
27
- 3. **Configure URLs:**
28
- In your project's `urls.py`:
29
- ```python
30
- from django.urls import path, include
31
-
32
- urlpatterns = [
33
- ...
34
- path('sidebar/', include('sidebar.urls')),
35
- ...
36
- ]
37
- ```
38
-
39
- 4. **Add to your Base Template:**
40
- 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.
41
-
42
- Example structure using Flexbox:
43
- ```html
44
- <body>
45
- <div class="d-flex">
46
- <!-- Sidebar -->
47
- {% include "sidebar/content.html" %}
48
-
49
- <!-- Main Content -->
50
- <div class="flex-grow-1">
51
- {% block content %}{% endblock %}
52
- </div>
53
- </div>
54
-
55
- <!-- Bootstrap JS (Required) -->
56
- <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
57
- </body>
58
- ```
59
-
60
- ## Customization
61
-
62
- ### Overriding Content
63
- 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.
64
-
65
- **Path:** `your_project/templates/sidebar/content.html`
66
-
67
- 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.
68
-
69
- ### Positioning
70
- 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/micro_sidebar.egg-info/PKG-INFO DELETED
@@ -1,98 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: micro_sidebar
3
- Version: 1.0.1
4
- Summary: A reusable Django sidebar for Web Apps
5
- Home-page: https://github.com/debeski/micro-sidebar
6
- Author: DeBeski
7
- Author-email: DeBeski <debeski1@gmail.com>
8
- License: MIT
9
- Project-URL: Homepage, https://github.com/debeski/micro-sidebar
10
- Classifier: Framework :: Django
11
- Classifier: Framework :: Django :: 5
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.8
14
- Classifier: Programming Language :: Python :: 3.9
15
- Classifier: Programming Language :: Python :: 3.10
16
- Classifier: Programming Language :: Python :: 3.11
17
- Classifier: Programming Language :: Python :: 3.12
18
- Classifier: Programming Language :: Python :: 3.13
19
- Classifier: Programming Language :: Python :: 3.14
20
- Classifier: License :: OSI Approved :: MIT License
21
- Classifier: Operating System :: OS Independent
22
- Requires-Python: >=3.9
23
- Description-Content-Type: text/markdown
24
- Requires-Dist: Django>=5.1
25
- Dynamic: author
26
- Dynamic: home-page
27
- Dynamic: requires-python
28
-
29
- # Micro Sidebar
30
-
31
- A reusable Django sidebar app for Web Apps.
32
-
33
- ## Requirements
34
-
35
- - **Django**: >= 5.1
36
- - **Bootstrap**: 5 (Required for consistent styling)
37
-
38
- ## Installation
39
-
40
- 1. **Install the package:**
41
- ```bash
42
- pip install micro-sidebar
43
- ```
44
-
45
- 2. **Add to `INSTALLED_APPS`:**
46
- In your `settings.py`:
47
- ```python
48
- INSTALLED_APPS = [
49
- ...
50
- 'sidebar',
51
- ...
52
- ]
53
- ```
54
-
55
- 3. **Configure URLs:**
56
- In your project's `urls.py`:
57
- ```python
58
- from django.urls import path, include
59
-
60
- urlpatterns = [
61
- ...
62
- path('sidebar/', include('sidebar.urls')),
63
- ...
64
- ]
65
- ```
66
-
67
- 4. **Add to your Base Template:**
68
- 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.
69
-
70
- Example structure using Flexbox:
71
- ```html
72
- <body>
73
- <div class="d-flex">
74
- <!-- Sidebar -->
75
- {% include "sidebar/content.html" %}
76
-
77
- <!-- Main Content -->
78
- <div class="flex-grow-1">
79
- {% block content %}{% endblock %}
80
- </div>
81
- </div>
82
-
83
- <!-- Bootstrap JS (Required) -->
84
- <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
85
- </body>
86
- ```
87
-
88
- ## Customization
89
-
90
- ### Overriding Content
91
- 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.
92
-
93
- **Path:** `your_project/templates/sidebar/content.html`
94
-
95
- 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.
96
-
97
- ### Positioning
98
- 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 → micro_sidebar-1.1.0}/MANIFEST.in RENAMED
File without changes
{micro_sidebar-1.0.1 → micro_sidebar-1.1.0}/setup.cfg RENAMED
File without changes