Fix wrongly formatted README (#132)

* Correct table format in README.rst * Add dist-dry-run github wf job
treasure-data · Jun 5, 2024 · a9fe301 · a9fe301
1 parent 89e2145
commit a9fe301
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 12 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -47,3 +47,23 @@ jobs:
       env:
         TD_API_KEY: 1/XXX
         TD_API_SERVER: https://api.treasure-data.com/
+
+  dist-dry-run:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and check dist for PiPY (a.k.a dry run)
+      run: |
+        python setup.py sdist bdist_wheel
+        twine check dist/*
+      
diff --git a/README.rst b/README.rst
@@ -131,19 +131,19 @@ data to Treasure Data:
 
 Characteristics of each of these methods can be summarized as follows:
 
-+-----------------------------------+------------------+------------------+-----------+
++-----------------------------------+------------------+------------------+---------------------------------+
 |                                   | ``bulk_import``  | ``insert_into``  | ``spark (No longer available)`` |
-+===================================+==================+==================+===========+
-| Scalable against data volume      |        ✓         |                  |     ✓     |
-+-----------------------------------+------------------+------------------+-----------+
-| Write performance for larger data |                  |                  |     ✓     |
-+-----------------------------------+------------------+------------------+-----------+
-| Memory efficient                  |        ✓         |        ✓         |           |
-+-----------------------------------+------------------+------------------+-----------+
-| Disk efficient                    |                  |        ✓         |           |
-+-----------------------------------+------------------+------------------+-----------+
-| Minimal package dependency        |        ✓         |        ✓         |           |
-+-----------------------------------+------------------+------------------+-----------+
++===================================+==================+==================+=================================+
+| Scalable against data volume      |        ✓         |                  |                 ✓               |
++-----------------------------------+------------------+------------------+---------------------------------+
+| Write performance for larger data |                  |                  |                 ✓               |
++-----------------------------------+------------------+------------------+---------------------------------+
+| Memory efficient                  |        ✓         |        ✓         |                                 |
++-----------------------------------+------------------+------------------+---------------------------------+
+| Disk efficient                    |                  |        ✓         |                                 |
++-----------------------------------+------------------+------------------+---------------------------------+
+| Minimal package dependency        |        ✓         |        ✓         |                                 |
++-----------------------------------+------------------+------------------+---------------------------------+
 
 Enabling Spark Writer
 ^^^^^^^^^^^^^^^^^^^^^

diff --git a/setup.cfg b/setup.cfg
@@ -10,6 +10,7 @@ license = Apache License 2.0
 license_files =
     LICENSE
 long_description = file: README.rst
+long_description_content_type = text/x-rst
 url = https://github.com/treasure-data/pytd
 classifiers =
     Development Status :: 5 - Production/Stable