django-nx 0.1.0__tar.gz

django_nx-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

django_nx-0.1.0/LICENSE

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

django_nx-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: django-nx
+Version: 0.1.0
+Summary: Lightweight Django field utilities and extensions
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: django<6.1,>=3.2
+Requires-Dist: djangorestframework<3.18,>=3.12.4
+Description-Content-Type: text/markdown
+
+# django-nx
+django-nx — Lightweight Django field utilities and extensions

django_nx-0.1.0/README.md

@@ -0,0 +1,2 @@
+# django-nx
+django-nx — Lightweight Django field utilities and extensions

django_nx-0.1.0/nx/models/fields.py

@@ -0,0 +1,320 @@
+"""
+Custom Django model fields with enhanced defaults and behaviors.
+
+This module provides extended versions of Django's model fields with:
+
+- Automatic help_text generation from verbose_name
+- Sensible default values for common use cases
+- Specialized fields for money/decimal amounts
+- Choice field variants for integer and text options
+
+Available Fields
+----------------
+
+:CharField: CharField with empty string default and auto help_text
+:IntegerField: IntegerField with auto help_text support
+:MoneyField: DecimalField configured for monetary amounts
+:TextField: TextField with empty string default and auto help_text
+:BooleanField: BooleanField defaulting to False
+:IntChoiceField: SmallIntegerField for choice options
+:TextChoiceField: CharField for text-based choices
+:ForeignKey: ForeignKey with null/blank defaults
+:OneToOne: OneToOneField with null/blank defaults
+:ManyToMany: ManyToManyField with null/blank defaults
+:ObjectField: JSONField defaulting to empty dict
+:ArrayField: JSONField defaulting to empty list
+"""
+
+from decimal import Decimal
+
+from django.db import models
+
+
+class CharField(models.CharField):
+    """
+    A CharField that defaults to an empty string and allows blank values.
+    This is useful for character fields where you want to avoid NULL values in the database
+    and have a consistent empty string as the default.
+
+    If help_text is not provided, it will use the verbose_name as help_text.
+
+    default max_length is 128
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("default", "")
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("max_length", 128)
+
+        # If help_text not provided, use verbose_name when available
+        if "help_text" not in kwargs and "verbose_name" in kwargs:
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)
+
+
+class IntegerField(models.IntegerField):
+    """
+
+    If help_text is not provided, it will use the verbose_name as help_text.
+
+    """
+
+    def __init__(self, *args, **kwargs):
+        # If help_text is not provided, use verbose_name as help_text
+        if "help_text" not in kwargs and "verbose_name" in kwargs:
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)
+
+
+class MoneyField(models.DecimalField):
+    """
+    MoneyField for monetary amounts using DECIMAL under the hood.
+
+    :param verbose_name: Human-readable name for the field
+    :param max_digits: Maximum number of digits (default: 18)
+    :param decimal_places: Number of decimal places (default: 2)
+    :param default: Default value (default: Decimal('0'))
+
+    Example::
+
+        amount = MoneyField('金额')
+        tax = MoneyField('税额', max_digits=14, decimal_places=4)
+    """
+
+    def __init__(self, verbose_name=None, *args, **kwargs):
+        # Sensible defaults; allow override by explicit kwargs
+        kwargs["max_digits"] = kwargs.get("max_digits", 18)
+        kwargs["decimal_places"] = kwargs.get("decimal_places", 2)
+        kwargs["default"] = kwargs.get("default", Decimal("0"))
+
+        # If help_text not provided, mirror verbose_name when available
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(verbose_name, *args, **kwargs)
+
+
+class TextField(models.TextField):
+    """
+    A TextField that defaults to an empty string and allows blank values.
+    This is useful for character fields where you want to avoid NULL values in the database
+    and have a consistent empty string as the default.
+
+    If help_text is not provided, it will use the verbose_name as help_text.
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("default", "")
+        kwargs.setdefault("blank", True)
+
+        # If help_text not provided, use verbose_name when available
+        if "help_text" not in kwargs and "verbose_name" in kwargs:
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)
+
+
+class BooleanField(models.BooleanField):
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("default", False)
+        kwargs.setdefault("blank", True)
+
+        # If help_text not provided, use verbose_name when available
+        if "help_text" not in kwargs and "verbose_name" in kwargs:
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)
+
+
+class IntChoiceField(models.SmallIntegerField):
+    """
+    A SmallIntegerField that present as Choice Field.
+
+    If help_text is not provided, it will use the verbose_name as help_text.
+    """
+
+    def __init__(self, verbose_name=None, choices=None, *args, **kwargs):
+        if choices is not None:
+            kwargs["choices"] = choices
+
+        # If help_text not provided, use verbose_name when available
+        if "help_text" not in kwargs and verbose_name is not None:
+            kwargs["help_text"] = verbose_name
+
+        super().__init__(verbose_name, *args, **kwargs)
+
+
+class TextChoiceField(models.CharField):
+    """
+    A CharField that present as Choice Field.
+
+    If help_text is not provided, it will use the verbose_name as help_text.
+
+    Default `max_length` is 64
+    """
+
+    def __init__(self, verbose_name=None, choices=None, *args, **kwargs):
+        if choices is not None:
+            kwargs["choices"] = choices
+        kwargs.setdefault("max_length", 64)  # Default max length for choice fields
+
+        # If help_text not provided, use verbose_name when available
+        if "help_text" not in kwargs and verbose_name is not None:
+            kwargs["help_text"] = verbose_name
+
+        super().__init__(verbose_name, *args, **kwargs)
+
+
+class ForeignKey(models.ForeignKey):
+    """
+    A ForeignKey that defaults to common settings for reference fields.
+
+    Defaults:
+    - null=True
+    - blank=True
+    - default=None
+
+    Usage:
+        user = nx.ForeignKey('auth.User', 'user')
+        warehouse = nx.ForeignKey('admin_model.KZWareHouse', 'warehouse')
+    """
+
+    def __init__(self, to, verbose_name=None, *args, **kwargs):
+        # Sensible defaults for foreign keys
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("default", None)
+
+        # If help_text not provided, use verbose_name when available
+        if verbose_name:
+            kwargs["verbose_name"] = verbose_name
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(to, *args, **kwargs)
+
+
+class OneToOne(models.OneToOneField):
+    """
+    A OneToOneField that defaults to common settings for reference fields.
+
+    Defaults:
+    - null=True
+    - blank=True
+    - default=None
+
+    Usage:
+        user = nx.OneToOne('auth.User', 'user')
+        warehouse = nx.OneToOne('admin_model.KZWareHouse', 'warehouse')
+    """
+
+    def __init__(self, to, verbose_name=None, *args, **kwargs):
+        # Sensible defaults for foreign keys
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("default", None)
+
+        # If help_text not provided, use verbose_name when available
+        if verbose_name:
+            kwargs["verbose_name"] = verbose_name
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(to, *args, **kwargs)
+
+
+class ManyToMany(models.ManyToManyField):
+    """
+    A ManyToManyField that defaults to common settings for reference fields.
+
+    Defaults:
+    - null=True
+    - blank=True
+    - default=None
+
+    Usage:
+        user = nx.ManyToMany('auth.User', 'user')
+        warehouse = nx.ManyToMany('admin_model.KZWareHouse', 'warehouse')
+    """
+
+    def __init__(self, to, verbose_name=None, *args, **kwargs):
+        # Sensible defaults for foreign keys
+        kwargs.setdefault("null", True)
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("default", None)
+
+        # If help_text not provided, use verbose_name when available
+        if verbose_name:
+            kwargs["verbose_name"] = verbose_name
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(to, *args, **kwargs)
+
+
+class ObjectField(models.JSONField):
+    """
+    A JSONField that defaults to common settings for reference fields.
+
+    Defaults:
+    - blank=True
+    - default={}
+    """
+
+    def __init__(self, *args, **kwargs):
+        # Sensible defaults for foreign keys
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("default", dict)
+
+        # If help_text not provided, use verbose_name when available
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)
+
+
+class ArrayField(models.JSONField):
+    """
+    A JSONField that defaults to common settings for reference fields.
+
+    Defaults:
+    - blank=True
+    - default=[]
+    """
+
+    def __init__(self, *args, **kwargs):
+        # Sensible defaults for foreign keys
+        kwargs.setdefault("blank", True)
+        kwargs.setdefault("default", list)
+
+        # If help_text not provided, use verbose_name when available
+        if (
+            "help_text" not in kwargs
+            and "verbose_name" in kwargs
+            and kwargs["verbose_name"]
+        ):
+            kwargs["help_text"] = kwargs["verbose_name"]
+
+        super().__init__(*args, **kwargs)

django_nx-0.1.0/nx/nx.py

@@ -0,0 +1,32 @@
+"""
+Nx package - Extended Django model fields and utilities.
+
+This package provides custom Django model fields with enhanced defaults
+and behaviors, including automatic help_text generation and specialized
+field types for common use cases.
+
+Quick Start
+-----------
+
+Import fields directly from the nx package::
+
+    from nx import nx
+
+
+"""
+
+from .models.fields import (
+    CharField,
+    IntegerField,
+    TextField,
+    BooleanField,
+    IntChoiceField,
+    TextChoiceField,
+    MoneyField,
+    ForeignKey,
+    OneToOne,
+    ManyToMany,
+    ObjectField,
+    ArrayField,
+)
+from . import restframework as drf

django_nx-0.1.0/nx/restframework/serializers.py

@@ -0,0 +1,5 @@
+from rest_framework import serializers
+
+
+class MethodField(serializers.SerializerMethodField):
+    pass

django_nx-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "django-nx"
+version = "0.1.0"
+description = "Lightweight Django field utilities and extensions"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "django>=3.2,<6.1",
+    "djangorestframework>=3.12.4,<3.18",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["nx"]
+
+[tool.hatch.build.targets.wheel]
+include = ["nx"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"