Merge pull request #63 from koladev32/62-add-migrating-documentation

62 add migrating documentation
koladev32 · May 23, 2024 · 82398e4 · 82398e4
2 parents 6f3201d + 8dec119
commit 82398e4
Show file tree

Hide file tree

Showing 8 changed files with 88 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,9 +4,16 @@ Changelog
 [Unreleased]
 ------------
 
+[v2.1.0] - 2024-05-23
+------------------
+
+- Add migrating documentation (#62)  
+
 [v2.0.1] - 2024-05-23
 ------------------
 
+- Renaming package
+
 [v2.0.0] - 2024-05-23
 ------------------
 

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,16 @@
 Changelog
 =========
 
+[v2.0.1] - 2024-05-23
+------------------
+
+- Renaming package
+
+[v2.0.0] - 2024-05-23
+------------------
+
+- Rename project (#56)
+
 [v1.1.0] - 2024-05-23
 ------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -41,6 +41,7 @@ Contents
     authentication
     rotation
     analytics
+    migrating
     development_and_contributing
     changelog
 

diff --git a/docs/migrating.rst b/docs/migrating.rst
@@ -0,0 +1,66 @@
+Package Renaming Migration Guide
+================================
+
+As part of our efforts to streamline our package offerings, the ``djangorestframework-simple-apikey`` has been renamed to ``drf-simple-apikey``. This section provides a detailed guide on how to migrate your project to use the new package name.
+
+Renaming the Package
+--------------------
+
+1. **Uninstall the Old Package**:
+   Remove the existing package by running the following command in your terminal:
+
+   .. code-block:: bash
+
+      pip uninstall djangorestframework-simple-apikey
+
+2. **Install the New Package**:
+   Install the new package using pip:
+
+   .. code-block:: bash
+
+      pip install drf-simple-apikey
+
+Updating Project Imports
+------------------------
+
+You will need to update your import statements in your Django project. Change all existing import statements from:
+
+.. code-block:: python
+
+   import djangorestframework_simple_apikey
+
+to:
+
+.. code-block:: python
+
+   import drf_simple_apikey
+
+Migrating Django Settings
+-------------------------
+
+Update your Django project settings to reflect the changes in the package configuration:
+
+- Change any references from ``SIMPLE_API_KEY`` settings to ``DRF_API_KEY``. For example:
+
+  .. code-block:: python
+
+     # Old settings
+     SIMPLE_API_KEY = {
+         'API_KEY': 'your-api-key-here',
+         'OTHER_SETTINGS': 'values'
+     }
+
+     # New settings
+     DRF_API_KEY = {
+         'API_KEY': 'your-api-key-here',
+         'OTHER_SETTINGS': 'values'
+     }
+
+Ensure that you update these settings throughout your project configuration files to avoid any issues during deployment or development.
+
+Support and Feedback
+--------------------
+
+For more information, detailed support, or to provide feedback about the migration process, please visit our documentation site at [New Package Documentation URL](https://example.com/new-package-info) or contact support directly.
+
+We appreciate your cooperation and understanding as we continue to improve our software offerings.
diff --git a/drf_simple_apikey/version.py b/drf_simple_apikey/version.py
@@ -1 +1 @@
-VERSION = "2.0.1"
+VERSION = "2.1.0"
diff --git a/example/requirements.txt b/example/requirements.txt
@@ -1,3 +1,3 @@
 Django==4.1.13
 djangorestframework==3.14.0
-drf-simple-apikey==0.1.2
+drf-simple-apikey==2.0.1
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,5 +6,5 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "drf-simple-apikey"
-version = "2.0.1"
+version = "2.1.0"
 dynamic = ["description", "readme", "optional-dependencies", "dependencies", "classifiers", "authors", "license"]
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.0.1
+current_version = 2.1.0
 commit = True
 tag = True