Merge pull request #77 from danielbolivar/main

fix: update documentation to use correct package naming convention fo…
koladev32 · Dec 28, 2024 · b0d3c45 · b0d3c45
2 parents f310096 + d2d8708
commit b0d3c45
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/docs/analytics.rst b/docs/analytics.rst
@@ -39,8 +39,8 @@ To use the `ApiKeyAnalyticsMiddleware`, follow these setup instructions:
        INSTALLED_APPS = (
            ...
            "rest_framework",
-           "drf-simple-apikey",
-           "drf-simple-apikey.analytics",  # Ensure this app is added
+           "drf_simple_apikey",
+           "drf_simple_apikey.analytics",  # Ensure this app is added
        )
 
 2. Add the `ApiKeyAnalyticsMiddleware` to the `MIDDLEWARE` settings in your Django configuration.
@@ -50,7 +50,7 @@ To use the `ApiKeyAnalyticsMiddleware`, follow these setup instructions:
        MIDDLEWARE = [
            ...
            'django.middleware.security.SecurityMiddleware',
-           'drf-simple-apikey.analytics.middleware.ApiKeyAnalyticsMiddleware',  # Add the middleware here
+           'drf_simple_apikey.analytics.middleware.ApiKeyAnalyticsMiddleware',  # Add the middleware here
            ...
        ]
 

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -58,7 +58,7 @@ file:
    INSTALLED_APPS = [
      # ...
      "rest_framework",
-     "drf-simple-apikey",
+     "drf_simple_apikey",
    ]
 
 3- Add the ``FERNET_KEY`` setting in your ``DRF_API_KEY``
@@ -88,7 +88,7 @@ permission class.
 
    from rest_framework import viewsets
 
-   from drf-simple-apikey.backends import APIKeyAuthentication
+   from drf_simple_apikey.backends import APIKeyAuthentication
    from rest_framework.response import Response
 
    class FruitViewSets(viewsets.ViewSet):
@@ -125,4 +125,4 @@ Contributing
 ------------
 
 See
-`CONTRIBUTING.md <https://github.com/koladev32/drf-simple-apikey/blob/main/CONTRIBUTING.md>`__.
+`CONTRIBUTING.md <https://github.com/koladev32/drf-simple-apikey/blob/main/CONTRIBUTING.md>`__.
diff --git a/docs/permissions.rst b/docs/permissions.rst
@@ -31,12 +31,12 @@ You can then call use this class in your view 👇
 
 .. code:: python
 
-   from drf-simple-apikey.permissions import IsActiveEntity
+   from drf_simple_apikey.permissions import IsActiveEntity
 
    class YourViewSet(viewsets.ViewSet):
        ...
        authentication_classes = (APIKeyAuthentication, )
        permission_classes = (IsActiveEntity, )
 
 Feel free to read the code of the permission class at
-`https://github.com/koladev32/drf-simple-apikey/blob/main/drf-simple-apikey/permissions.py <https://github.com/koladev32/drf-simple-apikey/blob/main/drf-simple-apikey/backends.py>`__.
+`https://github.com/koladev32/drf-simple-apikey/blob/main/drf-simple-apikey/permissions.py <https://github.com/koladev32/drf-simple-apikey/blob/main/drf-simple-apikey/backends.py>`__.
diff --git a/docs/rotation.rst b/docs/rotation.rst
@@ -23,15 +23,15 @@ Activation
 
 Before activating a rotation, ensure to set the rotating Fernet key ``ROTATION_FERNET_SECRET`` in the settings of the package.
 
-You will need to add the rotation app ``drf-simple-apikey.rotation`` in the ``INSTALLED_APPS`` Django setting of your project.
+You will need to add the rotation app ``drf_simple_apikey.rotation`` in the ``INSTALLED_APPS`` Django setting of your project.
 
    .. code-block:: python
 
        INSTALLED_APPS=(
             ...
             "rest_framework",
-            "drf-simple-apikey",
-            "drf-simple-apikey.rotation", # added app
+            "drf_simple_apikey",
+            "drf_simple_apikey.rotation", # added app
         )
 
 And you will need to run the migrate command:
@@ -102,4 +102,4 @@ Key Usage During Rotation
   transition phase, ensuring that existing keys remain valid.
 
 - **Encryption**: During rotation, new API keys are encrypted using the new key to ensure enhanced
-  security.
+  security.