vanta-admin 0.1.3__tar.gz → 0.1.5__tar.gz

{vanta_admin-0.1.3/vanta_admin.egg-info → vanta_admin-0.1.5}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: vanta-admin
-Version: 0.1.3
+Version: 0.1.5
 Summary: A sharp, dark, and portable Django admin theme forged for builders who want the admin to feel less default.
 Author: oli-dev0
 License-Expression: MIT
 Project-URL: Homepage, https://vanta-admin.org/
-Project-URL: Documentation, https://github.com/oli-dev0/vanta-admin/blob/main/packages/vanta_admin/README.md
-Project-URL: Repository, https://github.com/oli-dev0/vanta-admin
-Project-URL: Issues, https://github.com/oli-dev0/vanta-admin/issues
+Project-URL: Documentation, https://github.com/oli-dev0/vanta-admin-theme/blob/main/README.md
+Project-URL: Repository, https://github.com/oli-dev0/vanta-admin-theme
+Project-URL: Issues, https://github.com/oli-dev0/vanta-admin-theme/issues
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 6.0
 Classifier: Programming Language :: Python :: 3
@@ -30,6 +30,20 @@ and a standalone structure that stays close to Django's admin template system.
 It is designed to be portable and to avoid frontend runtime dependencies outside
 standard Django admin behavior.
 
+## What It Adds
+
+- A fixed sidebar with persistent collapsed state and remembered open sections.
+- Light and dark theme support through CSS tokens.
+- A denser dashboard, changelist, filter, message, and form presentation.
+- Default icons for common admin apps, models, and recent actions.
+- A responsive mobile sidebar overlay.
+- Optional themed templates for `django-two-factor-auth` login, setup completion,
+  account security, and backup-token flows.
+
+Vanta Admin does not replace Django admin, change your permissions, or configure
+two-factor authentication for you. If your project uses `django-two-factor-auth`,
+Vanta provides matching templates and CSS for the visible 2FA screens.
+
 ## Tested With
 Vanta Admin was created and tested with:
 
@@ -54,12 +68,12 @@ uv add vanta-admin
 
 ### Directly from GitHub with pip
 ```bash
-pip install "git+https://github.com/oli-dev0/vanta-admin.git@main#subdirectory=packages/vanta_admin"
+pip install "git+https://github.com/oli-dev0/vanta-admin-theme.git@main"
 ```
 
 ### Directly from GitHub with uv
 ```bash
-uv add "git+https://github.com/oli-dev0/vanta-admin.git@main#subdirectory=packages/vanta_admin"
+uv add "git+https://github.com/oli-dev0/vanta-admin-theme.git@main"
 ```
 
 ## Django Setup
@@ -81,11 +95,34 @@ Then run your normal static asset flow for Django:
 python manage.py collectstatic
 ```
 
+## Optional Two-Factor Auth Theme Support
+
+If your project already uses `django-two-factor-auth`, place `vanta_admin` before
+the two-factor apps and before `django.contrib.admin` so Vanta's templates are
+found first:
+
+```python
+INSTALLED_APPS = [
+    'vanta_admin',
+    'django_otp',
+    'django_otp.plugins.otp_static',
+    'django_otp.plugins.otp_totp',
+    'two_factor',
+    'django.contrib.admin',
+    # ...
+]
+```
+
+Configure `django-two-factor-auth` normally in your project URLs and settings.
+Vanta only provides the theme layer.
+
 ## Notes
 - The package name on PyPI is `vanta-admin`.
 - The Django app label you add to `INSTALLED_APPS` is `vanta_admin`.
+- Two-factor auth support is visual/template support for projects that already
+  install and configure `django-two-factor-auth`.
 
 ## Links
 - Website: https://vanta-admin.org/
-- Repository: https://github.com/oli-dev0/vanta-admin
-- Issues: https://github.com/oli-dev0/vanta-admin/issues
+- Repository: https://github.com/oli-dev0/vanta-admin-theme
+- Issues: https://github.com/oli-dev0/vanta-admin-theme/issues

vanta_admin-0.1.5/README.md

@@ -0,0 +1,103 @@
+# Vanta Admin
+Vanta Admin is a Django admin theme with a darker interface, tighter density,
+and a standalone structure that stays close to Django's admin template system.
+
+It is designed to be portable and to avoid frontend runtime dependencies outside
+standard Django admin behavior.
+
+## What It Adds
+
+- A fixed sidebar with persistent collapsed state and remembered open sections.
+- Light and dark theme support through CSS tokens.
+- A denser dashboard, changelist, filter, message, and form presentation.
+- Default icons for common admin apps, models, and recent actions.
+- A responsive mobile sidebar overlay.
+- Optional themed templates for `django-two-factor-auth` login, setup completion,
+  account security, and backup-token flows.
+
+Vanta Admin does not replace Django admin, change your permissions, or configure
+two-factor authentication for you. If your project uses `django-two-factor-auth`,
+Vanta provides matching templates and CSS for the visible 2FA screens.
+
+## Tested With
+Vanta Admin was created and tested with:
+
+- Python 3.13.14
+- Django 6.0.6
+
+The package currently declares support for Django 5.2 up to, but not including,
+Django 7. Older supported-range versions may also work well, but they have not
+been verified as thoroughly yet.
+
+## Installation
+
+### PyPI with pip
+```bash
+pip install vanta-admin
+```
+
+### PyPI with uv
+```bash
+uv add vanta-admin
+```
+
+### Directly from GitHub with pip
+```bash
+pip install "git+https://github.com/oli-dev0/vanta-admin-theme.git@main"
+```
+
+### Directly from GitHub with uv
+```bash
+uv add "git+https://github.com/oli-dev0/vanta-admin-theme.git@main"
+```
+
+## Django Setup
+In your Django settings file, add `vanta_admin` to `INSTALLED_APPS` before
+`django.contrib.admin` so its templates override the default admin templates.
+
+This is usually in `settings.py`, or in your project's active settings module
+if you split settings across multiple files:
+```python
+INSTALLED_APPS = [
+    'vanta_admin',
+    'django.contrib.admin',
+    # ...
+]
+```
+
+Then run your normal static asset flow for Django:
+```bash
+python manage.py collectstatic
+```
+
+## Optional Two-Factor Auth Theme Support
+
+If your project already uses `django-two-factor-auth`, place `vanta_admin` before
+the two-factor apps and before `django.contrib.admin` so Vanta's templates are
+found first:
+
+```python
+INSTALLED_APPS = [
+    'vanta_admin',
+    'django_otp',
+    'django_otp.plugins.otp_static',
+    'django_otp.plugins.otp_totp',
+    'two_factor',
+    'django.contrib.admin',
+    # ...
+]
+```
+
+Configure `django-two-factor-auth` normally in your project URLs and settings.
+Vanta only provides the theme layer.
+
+## Notes
+- The package name on PyPI is `vanta-admin`.
+- The Django app label you add to `INSTALLED_APPS` is `vanta_admin`.
+- Two-factor auth support is visual/template support for projects that already
+  install and configure `django-two-factor-auth`.
+
+## Links
+- Website: https://vanta-admin.org/
+- Repository: https://github.com/oli-dev0/vanta-admin-theme
+- Issues: https://github.com/oli-dev0/vanta-admin-theme/issues

{vanta_admin-0.1.3 → vanta_admin-0.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vanta-admin"
-version = "0.1.3"
+version = "0.1.5"
 description = "A sharp, dark, and portable Django admin theme forged for builders who want the admin to feel less default."
 readme = "README.md"
 license = "MIT"
@@ -29,9 +29,9 @@ dependencies = [
 
 [project.urls]
 Homepage = "https://vanta-admin.org/"
-Documentation = "https://github.com/oli-dev0/vanta-admin/blob/main/packages/vanta_admin/README.md"
-Repository = "https://github.com/oli-dev0/vanta-admin"
-Issues = "https://github.com/oli-dev0/vanta-admin/issues"
+Documentation = "https://github.com/oli-dev0/vanta-admin-theme/blob/main/README.md"
+Repository = "https://github.com/oli-dev0/vanta-admin-theme"
+Issues = "https://github.com/oli-dev0/vanta-admin-theme/issues"
 
 [tool.setuptools]
 include-package-data = false

{vanta_admin-0.1.3 → vanta_admin-0.1.5}/vanta_admin/apps.py

@@ -2,4 +2,4 @@ from django.apps import AppConfig
 
 
 class VantaAdminConfig(AppConfig):
-    name = 'vanta_admin'
+    name = "vanta_admin"