refactor: Rename from pydantic-to-django-model to pydantic-to-djmodel (#7)

Author: xmnlab

.github/workflows/main.yaml

@@ -50,7 +50,7 @@ jobs:
           miniconda-version: "latest"
           environment-file: conda/dev.yaml
           channels: conda-forge,nodefaults
-          activate-environment: pydantic-to-django-model
+          activate-environment: pydantic-to-djmodel
           auto-update-conda: true
           conda-solver: libmamba
 

.github/workflows/release.yaml

@@ -26,7 +26,7 @@ jobs:
           miniconda-version: "latest"
           environment-file: conda/release.yaml
           channels: conda-forge,nodefaults
-          activate-environment: pydantic-to-django-model-release
+          activate-environment: pydantic-to-djmodel-release
           auto-update-conda: true
           conda-solver: libmamba
 

README.md

@@ -1,4 +1,4 @@
-# pydantic-to-django-model
+# pydantic-to-djmodel
 
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)![Mkdocs](https://img.shields.io/badge/Documentation%20engine-Mkdocs-orange)
 ![Conda](https://img.shields.io/badge/Virtual%20environment-conda-brightgreen?logo=anaconda)[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
@@ -13,11 +13,11 @@
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 ![Makim](https://img.shields.io/badge/Automation%20task-Makim-blue)![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-CI-blue?logo=githubactions)
 
-pydantic-to-django-model is a Python library that converts Pydantic BaseModels into Django ORM models. It maps Pydantic fields, validators, and constraints to Django model fields, supporting nested models and relationships. This simplifies data validation and database management, reducing code duplication and easing migrations.
+pydantic-to-djmodel is a Python library that converts Pydantic BaseModels into Django ORM models. It maps Pydantic fields, validators, and constraints to Django model fields, supporting nested models and relationships. This simplifies data validation and database management, reducing code duplication and easing migrations.
 
 - Software License: MIT
 
-- Documentation: https://pydantic-to-django-model.com
+- Documentation: https://pydantic-to-djmodel.com
 
 ## Features
 

conda/dev.yaml

@@ -1,4 +1,4 @@
-name: pydantic-to-django-model
+name: pydantic-to-djmodel
 channels:
   - nodefaults
   - conda-forge

conda/release.yaml

@@ -1,4 +1,4 @@
-name: pydantic-to-django-model-release
+name: pydantic-to-djmodel-release
 channels:
   - nodefaults
   - conda-forge

docs/contributing.md

@@ -4,7 +4,7 @@ In order to be able to contribute, it is important that you understand the
 project layout.
 
 This project uses the _src layout_, which means that the package code is located
-at `./src/pydantic_to_django_model`.
+at `./src/pydantic_to_djmodel`.
 
 For my information, check the official documentation:
 <https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/>
@@ -46,8 +46,8 @@ and “help wanted” is open to whoever wants to implement it.
 
 ### Write Documentation
 
-pydantic-to-django-model could always use more documentation, whether as part of
-the official pydantic-to-django-model docs, in docstrings, or even on the web in
+pydantic-to-djmodel could always use more documentation, whether as part of
+the official pydantic-to-djmodel docs, in docstrings, or even on the web in
 blog posts, articles, and such.
 
 ### Submit Feedback
@@ -63,15 +63,15 @@ If you are proposing a feature:
 
 ## Get Started
 
-Ready to contribute? Here’s how to set up `pydantic-to-django-model` for local
+Ready to contribute? Here’s how to set up `pydantic-to-djmodel` for local
 development.
 
-1. Fork the `pydantic-to-django-model` repo on GitHub.
+1. Fork the `pydantic-to-djmodel` repo on GitHub.
 2. Clone your fork locally and change to the directory of your project:
 
 ```bash
-$ git clone git@github.com:your_name_here/pydantic-to-django-model.git
-$ cd pydantic-to-django-model/
+$ git clone git@github.com:your_name_here/pydantic-to-djmodel.git
+$ cd pydantic-to-djmodel/
 ```
 
 ### Prepare and use virtual environment
@@ -83,7 +83,7 @@ that, ensure that conda is already available in your terminal session and run:
 
 ```bash
 $ conda env create env create --file conda/dev.yaml
-$ conda activate pydantic_to_django_model
+$ conda activate pydantic_to_djmodel
 ```
 
 Note: you can use `mamba env create` instead, if you have it already installed,
@@ -109,7 +109,7 @@ You are now ready to implement your changes or improvements.
 
 ### Install and Use Pre-commit Hooks
 
-- `pydantic-to-django-model` uses a set of `pre-commit` hooks to improve code
+- `pydantic-to-djmodel` uses a set of `pre-commit` hooks to improve code
   quality. The hooks can be installed locally using:
 
 ```bash
@@ -158,7 +158,7 @@ Before you submit a pull request, check that it meets these guidelines:
 ## Running tests locally
 
 The tests can be executed using the `test` dependencies of
-`pydantic-to-django-model` in the following way:
+`pydantic-to-djmodel` in the following way:
 
 ```bash
 $ python -m pytest
@@ -170,7 +170,7 @@ The coverage value can be obtained while running the tests using `pytest-cov` in
 the following way:
 
 ```bash
-$ python -m pytest --cov=pydantic-to-django-model tests/
+$ python -m pytest --cov=pydantic-to-djmodel tests/
 ```
 
 A much more detailed guide on testing with `pytest` is available

docs/example.ipynb

@@ -4,9 +4,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# pydantic-to-django-model\n",
+    "# pydantic-to-djmodel\n",
     "\n",
-    "pydantic-to-django-model is Python library that aims to do ...\n",
+    "pydantic-to-djmodel is Python library that aims to do ...\n",
     "\n",
     "## Getting Started\n",
     "\n",
@@ -21,7 +21,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import pydantic_to_django_model"
+    "import pydantic_to_djmodel"
    ]
   },
   {

docs/index.md

@@ -1,6 +1,6 @@
 ![LOGO](/images/logo.png)
 
-# pydantic-to-django-model
+# pydantic-to-djmodel
 
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)![Mkdocs](https://img.shields.io/badge/Documentation%20engine-Mkdocs-orange)
 ![Conda](https://img.shields.io/badge/Virtual%20environment-conda-brightgreen?logo=anaconda)[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -20,11 +20,11 @@
 ![Makim](https://img.shields.io/badge/Automation%20task-Makim-blue)
 ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-CI-blue?logo=githubactions)
 
-pydantic-to-django-model is a Python library that converts Pydantic BaseModels
+pydantic-to-djmodel is a Python library that converts Pydantic BaseModels
 into Django ORM models.
 
 - License: MIT
-- Documentation: https://pydantic-to-django-model.com
+- Documentation: https://pydantic-to-djmodel.com
 
 ## Features
 

docs/installation.md

@@ -2,13 +2,13 @@
 
 ## Stable release
 
-To install pydantic-to-django-model, run this command in your terminal:
+To install pydantic-to-djmodel, run this command in your terminal:
 
 ```bash
-pip install pydantic-to-django-model
+pip install pydantic-to-djmodel
 ```
 
-This is the preferred method to install pydantic-to-django-model, as it will
+This is the preferred method to install pydantic-to-djmodel, as it will
 always install the most recent stable release.
 
 If you don't have [pip](https://pip.pypa.io) installed, this
@@ -17,7 +17,7 @@ can guide you through the process.
 
 ## From sources
 
-The sources for pydantic-to-django-model can be downloaded from the
+The sources for pydantic-to-djmodel can be downloaded from the
 [Github repo]().
 
 You can either clone the public repository:

mkdocs.yaml

@@ -1,5 +1,5 @@
-site_name: pydantic-to-django-model
-site_url: https://pydantic-to-django-model.com
+site_name: pydantic-to-djmodel
+site_url: https://pydantic-to-djmodel.com
 repo_url: https://github.com/MYORG/MYREPO
 docs_dir: ./docs/
 site_dir: ./build/
@@ -113,7 +113,7 @@ markdown_extensions:
   - tables
   - toc
 extra:
-  project_name: "pydantic-to-django-model"
+  project_name: "pydantic-to-djmodel"
   team:
     - name: "Active maintainers"
       members:
@@ -137,4 +137,4 @@ extra:
       icon: :material-cancel:{ .cancel }
       description: Unlikely to ever be supported or no upstream support.
 
-copyright: "Copyright © 2022, pydantic-to-django-model Team"
+copyright: "Copyright © 2022, pydantic-to-djmodel Team"