fix: change package name and update readme (#12)

Signed-off-by: Steve0x2a <stevesough@gmail.com>
casdoor · Mar 11, 2022 · 1d521c6 · 1d521c6
1 parent 6b088bb
commit 1d521c6
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 4 deletions.
diff --git a/.github/build.yml → .github/workflows/build.yml b/.github/build.yml → .github/workflows/build.yml
@@ -9,7 +9,7 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    #needs:[test]
+    #needs: [test]
     steps:
       - name: Checkout
         uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -3,6 +3,12 @@ Casdoor's SDK for Python will allow you to easily connect your application to th
 
 Casdoor SDK is simple to use. We will show you the steps below.
 
+Casdoor-python-sdk is available on PyPI:
+
+```console
+$ pip install casdoor
+```
+
 ## Step1. Init Config
 Initialization requires 5 parameters, which are all str type:
 | Name (in order)  | Must | Description                                         |
@@ -14,7 +20,7 @@ Initialization requires 5 parameters, which are all str type:
 | org_name | Yes  |Organization name
 
 ```python
-from oauth.main import CasdoorSDK
+from casdoor import CasdoorSDK
 
 sdk = CasdoorSDK(
     endpoint,

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [metadata]
-name = casdoor-python-sdk
+name = casdoor
 version = 0.0.1
 author = ffyuanda
 author_email = shaoxuan.yuan02@gmail.com
@@ -24,7 +24,7 @@ classifiers =
 package_dir=
     =src
 packages =
-    oauth
+    casdoor
 setup_requires =
     setuptools
 install_requires =

diff --git a/src/oauth/__init__.py → src/casdoor/__init__.py b/src/oauth/__init__.py → src/casdoor/__init__.py
diff --git a/src/oauth/main.py → src/casdoor/main.py b/src/oauth/main.py → src/casdoor/main.py
diff --git a/src/oauth/user.py → src/casdoor/user.py b/src/oauth/user.py → src/casdoor/user.py