[update] change name

Author: NatLee

README.md

@@ -1,23 +1,23 @@
-# Django Proxy API
+# Django Simple API Proxy
 
-This is a tool for proxying any APIs on Django server.
+This is a simple tool for proxying any APIs easily on your Django server.
 
 You can use it as middleware to make a layer for user authorization or something.
 
 ## Installation
 
 ```bash
-pip install djangoapiproxy
+pip install django-simple-api-proxy
 ```
 
 ## Quick Start
 
-1. Add `django_api_proxy` to your `INSTALLED_APPS` in `settings.py` like this:
+1. Add `django_simple_api_proxy` to your `INSTALLED_APPS` in `settings.py` like this:
 
 ```py
 INSTALLED_APPS = [
 ...
-'django_api_proxy',
+'django_simple_api_proxy',
 ]
 ```
 
@@ -29,13 +29,13 @@ PROXY_ROUTE_PATH = 'my_test_route'
 PROXY_TARGET_PATH = ''
 ```
 
-3. Include the `django_api_proxy` URL settings in your project `urls.py` like this:
+3. Include the `django_simple_api_proxy` URL settings in your project `urls.py` like this:
 
 ```py
 from django.conf import settings
 from django.urls import include
 urlpatterns += [
-    path(settings.PROXY_ROUTE_PATH, include('django_api_proxy.urls'))
+    path(settings.PROXY_ROUTE_PATH, include('django_simple_api_proxy.urls'))
 ]
 ```
 
@@ -54,9 +54,9 @@ And the result will be as below.
 
 ```log
 [06/Sep/2022 01:26:04] "GET /my_test_route/ HTTP/1.1" 200 314
-2022-09-06 01:26:06.338 | DEBUG    | django_api_proxy.views:get:73 - ----- Proxy GET
-2022-09-06 01:26:06.339 | DEBUG    | django_api_proxy.views:get_proxy_path:37 - URL: /get
-2022-09-06 01:26:06.340 | DEBUG    | django_api_proxy.views:update_payload:49 - Username: #anonymous
+2022-09-06 01:26:06.338 | DEBUG    | django_simple_api_proxy.views:get:73 - ----- Proxy GET
+2022-09-06 01:26:06.339 | DEBUG    | django_simple_api_proxy.views:get_proxy_path:37 - URL: /get
+2022-09-06 01:26:06.340 | DEBUG    | django_simple_api_proxy.views:update_payload:49 - Username: #anonymous
 ```
 
 ```json
@@ -100,7 +100,7 @@ from rest_framework.authentication import SessionAuthentication
 from rest_framework_simplejwt.authentication import JWTAuthentication
 from rest_framework.permissions import IsAuthenticated
 
-from django_api_proxy.views import APIProxy
+from django_simple_api_proxy.views import APIProxy
 
 class MyAPIProxy(APIProxy):
     # give custom authentication

example/api_proxy_example/api_proxy_example/settings.py

@@ -37,7 +37,7 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    'django_api_proxy' # add here
+    'django_simple_api_proxy' # add here
 ]
 
 

example/api_proxy_example/api_proxy_example/urls.py

@@ -26,5 +26,5 @@
 from django.urls import include
 
 urlpatterns += [
-    path(settings.PROXY_ROUTE_PATH, include('django_api_proxy.urls'))
+    path(settings.PROXY_ROUTE_PATH, include('django_simple_api_proxy.urls'))
 ]

setup.cfg

@@ -1,3 +1,3 @@
 [metadata]
-version = attr: django_api_proxy.__version__
+version = attr: django_simple_api_proxy.__version__
 license_files = LICENSE

setup.py

@@ -4,11 +4,11 @@
     long_description = fh.read()
 
 setuptools.setup(
-    name='django-api-proxy',
-    fullname='django-api-proxy',
+    name='django-simple-api-proxy',
+    fullname='django-simple-api-proxy',
     author='Nat Lee',
     author_email='[email protected]',
-    description='Proxy any APIs you want.',
+    description='Easy to proxy any APIs you want.',
     keywords='django, api, proxy, proxy pass',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -36,15 +36,10 @@
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',
     ],
-    python_requires='>=3.7',
+    python_requires='>=3.8',
     install_requires=['django>=4.0.0', 'requests', 'loguru', 'djangorestframework'],
     extras_require={
         'dev': ['check-manifest'],
         # 'test': ['coverage'],
     },
-    #entry_points={
-    #   'console_scripts': [
-    #      'django_api_proxy=django_api_proxy.cli:main'
-    #  ]
-    #}
 )

src/django_api_proxy/__init__.py renamed to src/django_simple_api_proxy/__init__.py

@@ -3,4 +3,4 @@
 
 class ApiProxyConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
-    name = 'django_api_proxy'
+    name = 'django_simple_api_proxy'