django-unfold 0.21.0__tar.gz → 0.22.0__tar.gz

{django_unfold-0.21.0 → django_unfold-0.22.0}/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Unfold Admin
+Copyright (c) 2023-present Unfold Admin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{django_unfold-0.21.0 → django_unfold-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-unfold
-Version: 0.21.0
+Version: 0.22.0
 Summary: Modern Django admin theme for seamless interface development
 Home-page: https://unfoldadmin.com
 License: MIT
@@ -59,6 +59,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Colors:** possibility to override default color scheme
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
+- **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
 
@@ -94,6 +95,9 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
   - [Compiling Tailwind](#compiling-tailwind)
+  - [Using VS Code with containers](#using-vs-code-with-containers)
+    - [Development server](#development-server)
+    - [Compiling Tailwind in devcontainer](#compiling-tailwind-in-devcontainer)
 - [Credits](#credits)
 
 ## Installation
@@ -989,6 +993,7 @@ Before adding any source code, it is recommended to have pre-commit installed on
 pip install pre-commit
 pre-commit install
 pre-commit install --hook-type commit-msg
+pre-commit run --all-files # Check if everything is okay
 ```
 
 ### Poetry configuration
@@ -1016,6 +1021,20 @@ Some components like datepickers, calendars or selectors in admin was not possib
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 
+### Using VS Code with containers
+
+Unfold already contains prepared support for VS Code development. After cloning the project locally, open the main folder in VS Code (in terminal `code .`). Immediately, you would see a message from VS Code **Folder contains a Dev Container configuration file. Reopen folder to develop in a container** which will inform you that the support for containers is prepared. Confirm the message by clicking on **Reopen in Container**. If the message is not there, you can still manually open the project in a container by running the command **Dev Containers: Reopen in Container**.
+
+#### Development server
+
+Now the VS Code will build an image and install Python dependencies. After successful installation is completed, VS Code will spin a container and from now it is possible to directly develop in the container. Unfold contains an example development application with the basic Unfold configuration available under `tests/server`. Run `python manage.py runserver` within a `tests/server` folder to start a development Django server. Note that you have to run the command from VS Code terminal which is already connected to the running container.
+
+**Note:** this is not a production ready server. Use it just for running tests or developing features & fixes.
+
+#### Compiling Tailwind in devcontainer
+
+The container has already a node preinstalled so it is possible to compile a new CSS. Open the terminal and run `npm install` which will install all dependencies and will create `node_modules` folder. Now, you can run npm commands for Tailwind as described in the previous chapter.
+
 ## Credits
 
 - [TailwindCSS](https://tailwindcss.com/) - CSS framework

{django_unfold-0.21.0 → django_unfold-0.22.0}/README.md

@@ -35,6 +35,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Colors:** possibility to override default color scheme
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
+- **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
 
@@ -70,6 +71,9 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
   - [Compiling Tailwind](#compiling-tailwind)
+  - [Using VS Code with containers](#using-vs-code-with-containers)
+    - [Development server](#development-server)
+    - [Compiling Tailwind in devcontainer](#compiling-tailwind-in-devcontainer)
 - [Credits](#credits)
 
 ## Installation
@@ -965,6 +969,7 @@ Before adding any source code, it is recommended to have pre-commit installed on
 pip install pre-commit
 pre-commit install
 pre-commit install --hook-type commit-msg
+pre-commit run --all-files # Check if everything is okay
 ```
 
 ### Poetry configuration
@@ -992,6 +997,20 @@ Some components like datepickers, calendars or selectors in admin was not possib
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 
+### Using VS Code with containers
+
+Unfold already contains prepared support for VS Code development. After cloning the project locally, open the main folder in VS Code (in terminal `code .`). Immediately, you would see a message from VS Code **Folder contains a Dev Container configuration file. Reopen folder to develop in a container** which will inform you that the support for containers is prepared. Confirm the message by clicking on **Reopen in Container**. If the message is not there, you can still manually open the project in a container by running the command **Dev Containers: Reopen in Container**.
+
+#### Development server
+
+Now the VS Code will build an image and install Python dependencies. After successful installation is completed, VS Code will spin a container and from now it is possible to directly develop in the container. Unfold contains an example development application with the basic Unfold configuration available under `tests/server`. Run `python manage.py runserver` within a `tests/server` folder to start a development Django server. Note that you have to run the command from VS Code terminal which is already connected to the running container.
+
+**Note:** this is not a production ready server. Use it just for running tests or developing features & fixes.
+
+#### Compiling Tailwind in devcontainer
+
+The container has already a node preinstalled so it is possible to compile a new CSS. Open the terminal and run `npm install` which will install all dependencies and will create `node_modules` folder. Now, you can run npm commands for Tailwind as described in the previous chapter.
+
 ## Credits
 
 - [TailwindCSS](https://tailwindcss.com/) - CSS framework

{django_unfold-0.21.0 → django_unfold-0.22.0}/pyproject.toml

@@ -1,21 +1,14 @@
 [tool.poetry]
 name = "django-unfold"
-version = "0.21.0"
+version = "0.22.0"
 description = "Modern Django admin theme for seamless interface development"
 license = "MIT"
 readme = "README.md"
 authors = []
 homepage = "https://unfoldadmin.com"
 repository = "https://github.com/unfoldadmin/django-unfold"
-packages = [
-    { include = "unfold", from = "src" },
-]
-keywords = [
-    "django",
-    "admin",
-    "tailwind",
-    "theme",
-]
+packages = [{ include = "unfold", from = "src" }]
+keywords = ["django", "admin", "tailwind", "theme"]
 classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.8",
@@ -39,7 +32,6 @@ pytest-django = "^4.5.2"
 tox = "^4.5.2"
 
 
-
 [tool.poetry.group.dev.dependencies]
 python-semantic-release = "^8.7.0"
 
@@ -56,23 +48,19 @@ select = [
     "UP", # pyupgrade
 ]
 ignore = [
-    "E501",  # line too long, handled by black
-    "B905",  # zip() without strict=True
-    "C901",  # too complex
+    "E501", # line too long, handled by black
+    "B905", # zip() without strict=True
+    "C901", # too complex
 ]
 
 [tool.semantic_release]
 tag_format = "{version}"
 major_on_zero = true
-version_toml = [
-    "pyproject.toml:tool.poetry.version"
-]
+version_toml = ["pyproject.toml:tool.poetry.version"]
 
 [tool.semantic_release.changelog]
 template_dir = ".github/templates"
-exclude_commit_patterns = [
-    "chore: version bump"
-]
+exclude_commit_patterns = ["chore: version bump"]
 
 [tool.semantic_release.changelog.environment]
 trim_blocks = true
@@ -85,8 +73,9 @@ upload_to_vcs_release = false
 addopts = """\
     --strict-config
     --strict-markers
-    --ds=tests.settings
+    --ds=example.settings
     """
+pythonpath = "tests/server"
 django_find_project = false
 
 [build-system]

{django_unfold-0.21.0 → django_unfold-0.22.0}/src/unfold/contrib/filters/apps.py

@@ -3,3 +3,4 @@ from django.apps import AppConfig
 
 class DefaultAppConfig(AppConfig):
     name = "unfold.contrib.filters"
+    label = "unfold_filters"

{django_unfold-0.21.0 → django_unfold-0.22.0}/src/unfold/contrib/forms/apps.py

@@ -3,3 +3,4 @@ from django.apps import AppConfig
 
 class DefaultAppConfig(AppConfig):
     name = "unfold.contrib.forms"
+    label = "unfold_forms"