Merge pull request #1 from Alma-field/develop

Release v1.0.0

.github/workflows/deploy.yml

@@ -0,0 +1,27 @@
+name: Deploy
+
+on:
+    release:
+        types: [published]
+    workflow_dispatch:
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v2
+          - name: Setup Python
+            uses: actions/setup-python@v2
+            with:
+                python-version: '3.x'
+          - name: Install dependencies
+            run: |
+                python -m pip install --upgrade pip
+                pip install twine wheel
+          - name: Build and publish
+            env:
+                TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+                TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+            run: |
+                python setup.py sdist
+                twine upload dist/*

README.md

@@ -4,19 +4,26 @@
 [![Documentation Status](https://readthedocs.org/projects/twitcaspy/badge/?version=latest)](http://twitcaspy.alma-field.com/en/latest/?badge=latest)
 [![GitHub issues open](https://img.shields.io/github/issues/Alma-field/twitcaspy.svg)](https://github.com/Alma-field/twitcaspy/issues?q=is%3Aopen+is%3Aissue)
 [![GitHub issues close](https://img.shields.io/github/issues-closed-raw/Alma-field/twitcaspy.svg)](https://github.com/Alma-field/twitcaspy/issues?q=is%3Aclose+is%3Aissue)
+[![Documentation Status](https://readthedocs.org/projects/twitcaspy/badge/?version=latest)](https://twitcaspy.alma-field.com/ja/latest/?badge=latest)
+[![PyPI Version](https://img.shields.io/pypi/v/twitcaspy?label=PyPI)](https://pypi.org/project/twitcaspy/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/twitcaspy?label=Python)](https://pypi.org/project/twitcaspy/)
 
 Twitcatting for Python
 
-## Other language version/他言語版
- - [English/英語](README.md)
- - [Japanese/日本語](README_JA.md)
+## Other language version
+ - [English](https://github.com/Alma-field/twitcaspy/blob/master/README.md)
+ - [Japanese](https://github.com/Alma-field/twitcaspy/blob/master/README_JA.md)
 
 ## Document
- - The "Read The Docs" document is in preparation.
- - [latest (v0.0.0)](https://twitcaspy.alma-field.com/en/latest)
- - [v0.0.0](https://twitcaspy.alma-field.com/en/0.0.0)
+ - [latest (v1.0.0)](https://twitcaspy.alma-field.com/en/latest)
+ - [v1.0.0](https://twitcaspy.alma-field.com/en/1.0.0)
 
 ## Installation
+The easiest way to install the latest version from PyPI is by using pip:
+```
+pip install twitcaspy
+```
+
 You can also use Git to clone the repository from GitHub to install the latest
 development version:
 ```

README_JA.md

@@ -4,6 +4,9 @@
 [![Documentation Status](https://readthedocs.org/projects/twitcaspy/badge/?version=latest)](http://twitcaspy.alma-field.com/ja/latest/?badge=latest)
 [![GitHub issues open](https://img.shields.io/github/issues/Alma-field/twitcaspy.svg)](https://github.com/Alma-field/twitcaspy/issues?q=is%3Aopen+is%3Aissue)
 [![GitHub issues close](https://img.shields.io/github/issues-closed-raw/Alma-field/twitcaspy.svg)](https://github.com/Alma-field/twitcaspy/issues?q=is%3Aclose+is%3Aissue)
+[![Documentation Status](https://readthedocs.org/projects/twitcaspy/badge/?version=latest)](https://twitcaspy.alma-field.com/ja/latest/?badge=latest)
+[![PyPI Version](https://img.shields.io/pypi/v/twitcaspy?label=PyPI)](https://pypi.org/project/twitcaspy/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/twitcaspy?label=Python)](https://pypi.org/project/twitcaspy/)
 
 Python用Twitcattingクライアントライブラリ
 
@@ -13,10 +16,15 @@ Python用Twitcattingクライアントライブラリ
 
 ## ドキュメント
  - "Read The Docs"ドキュメントは準備中です。
- - [最新版 (v0.0.0)](https://twitcaspy.alma-field.com/ja/latest)
- - [v0.0.0](https://twitcaspy.alma-field.com/ja/0.0.0)
+ - [最新版 (v1.0.0)](https://twitcaspy.alma-field.com/ja/latest)
+ - [v1.0.0](https://twitcaspy.alma-field.com/ja/1.0.0)
 
 ## インストール
+PyPIから最新バージョンはpipを用いてインストールできます。
+```
+pip install twitcaspy
+```
+
 GitHubからリポジトリのクローンを作成することで、最新の開発バージョンをインストールすることもできます。
 ```
 git clone https://github.com/Alma-field/twitcaspy.git

setup.cfg

@@ -1,2 +1,24 @@
+[metadata]
+name = twitcaspy
+version = attr:twitcaspy.__version__
+author = Alma field
+author_email = [email protected]
+description = Twitcasting library for Python
+long_description_content_type = text/markdown
+license = MIT
+url = https://github.com/Alma-field/twitcaspy
+classifiers =
+    Topic :: Software Development :: Libraries
+    License :: OSI Approved :: MIT License
+    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 :: 3 :: Only
+
+[options]
+zip_safe = True
+
 [nosetests]
 tests = tests.test_api

setup.py

@@ -1,18 +1,8 @@
 import re
 from setuptools import find_packages, setup
 
-VERSION_FILE = "twitcaspy/__init__.py"
-with open(VERSION_FILE) as version_file:
-    match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
-                      version_file.read(), re.MULTILINE)
-
-if match:
-    version = match.group(1)
-else:
-    raise RuntimeError(f"Unable to find version string in {VERSION_FILE}.")
-
-with open("README.md", "r", encoding='utf-8') as readme_file:
-    long_description = readme_file.read()
+with open("README.md") as file:
+    long_description = file.read()
 
 tests_require = [
     "nose>=1.3.7,<2",
@@ -25,15 +15,7 @@
 ]
 
 setup(
-    name="twitcaspy",
-    version=version,
-    description="Twitcasting library for Python",
     long_description=long_description,
-    long_description_content_type="text/markdown",
-    license="MIT",
-    author="Alma-field",
-    author_email="",
-    url="https://github.com/Alma-field/twitcaspy",
     project_urls={
         "Documentation": "https://twitcaspy.alma-field.com/",
         "Issue Tracker": "https://github.com/Alma-field/twitcaspy/issues",
@@ -51,16 +33,5 @@
     },
     test_suite="nose.collector",
     keywords="twitcasting library",
-    python_requires=">=3.7",
-    classifiers=[
-        "Topic :: Software Development :: Libraries",
-        "License :: OSI Approved :: MIT License",
-        "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 :: 3 :: Only",
-    ],
-    zip_safe=True,
+    python_requires=">=3.7"
 )

twitcaspy/__init__.py

@@ -5,7 +5,7 @@
 """
 Twitcaspy : Twitcasting API library
 """
-__version__ = '0.0.0'
+__version__ = '1.0.0'
 __author__ = 'Alma-field'
 __license__ = 'MIT'