Ready to publish (#31)

* Ready to publish

* Lint

* Fix python version string

* Fix module name and README

* Fix requirements

* Use PyPi token instead of ID/PW

* Add 3.10 matrix for pytest

* Address comments

* Update author

* Update README.md

Co-authored-by: Ikhun Um <[email protected]>

Co-authored-by: Ikhun Um <[email protected]>

Author: hexoul

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPi
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: "3.x"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: "__token__" # https://github.com/pypa/twine/blob/main/tests/test_integration.py#L46-L66
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN_CENTRALDOGMA }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/central-dogma.yml .github/workflows/test.yml

@@ -1,4 +1,3 @@
-
 name: Testing Central Dogma Python
 
 on:
@@ -31,8 +30,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, ubuntu-latest]
-        python-version: [3.7, 3.8, 3.9]
+        os: [ubuntu-latest]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
       - uses: actions/checkout@v2
@@ -65,7 +64,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, windows-latest]
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -1,22 +1,25 @@
 # Central Dogma client in Python
-Python client library for Central Dogma
+<a href="https://pypi.org/project/centraldogma-python/">
+    <img src="https://badge.fury.io/py/centraldogma-python.svg" alt="Package version">
+</a>
 
-🚧 WIP - Initial development is in progress 🚧
+Python client library for [Central Dogma](https://line.github.io/centraldogma/)
 
 ## Install
 ```
-$ pip install -r requirements.txt
-$ pip install --user .
+$ pip install centraldogma-python
 ```
 
-## Usage
-### Getting started
-Please see [`examples` folder](https://github.com/line/centraldogma-python/tree/main/examples) for more detail.
-```python
-client = ApiClient(base_url, token, timeout=30)
-client.list_projects()
-...
+## Getting started
+```pycon
+>>> from centraldogma.dogma import Dogma
+>>> dogma = Dogma("https://dogma.yourdomain.com", "token")
+>>> dogma.list_projects()
+[]
 ```
+Please see [`examples` folder](https://github.com/line/centraldogma-python/tree/main/examples) for more detail.
+
+---
 
 ## Development
 ### Tests

setup.py

@@ -11,37 +11,45 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-import os
 from setuptools import setup
 
-package_root = os.path.abspath(os.path.dirname(__file__))
-readme_filename = os.path.join(package_root, "README.md")
-with open("README.md", "r") as fh:
-    long_description = fh.read()
+
+def get_long_description():
+    with open("README.md", "r") as f:
+        return f.read()
+
 
 setup(
-    name="centraldogma",
-    version="0.1.0",
-    packages=["centraldogma", "centraldogma.data"],
-    description="Central Dogma client in Python",
-    long_description=long_description,
+    name="centraldogma-python",
+    version="0.1.1",
+    description="Python client library for Central Dogma",
+    long_description=get_long_description(),
     long_description_content_type="text/markdown",
     url="https://github.com/line/centraldogma-python",
-    author="",
-    author_email="",
-    license="Apache 2.0",
-    install_requires=["httpx", "marshmallow", "dataclasses-json"],
+    author="Central Dogma Team",
+    author_email="[email protected]",
+    license="Apache License 2.0",
+    packages=["centraldogma", "centraldogma.data"],
+    install_requires=[
+        "httpx",
+        "marshmallow",
+        "dataclasses-json",
+        "pydantic",
+        "python-dateutil",
+    ],
     python_requires=">=3.7",
     keywords="centraldogma",
     classifiers=[
+        "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",
+        "Programming Language :: Python",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python",
+        "Programming Language :: Python :: 3.10",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
 )