diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..cdd1132 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,30 @@ +# This workflows uploads a Python Package using Flit when a release is created +# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries + +name: Publish + +on: + release: + types: [published] + +jobs: + publish: + name: Upload a release to PyPI + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v3 + with: + python-version: 3.9 + + - name: Install Flit + run: | + python -m pip install flit + + - name: Publish + env: + FLIT_USERNAME: __token__ + FLIT_PASSWORD: ${{ secrets.PYPI_TOKEN }} + run: python -m flit publish diff --git a/README.md b/README.md index 38b5256..699bee5 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Use the GoDice Python API to integrate GoDice functionality into your own Python applications +![PyPI - Version](https://img.shields.io/pypi/v/godice) + **Supported features:** * Turn ON/OFF GoDice RGB LEDs @@ -15,20 +17,10 @@ Use the GoDice Python API to integrate GoDice functionality into your own Python ## Installation -- once deployed to PyPI - ``` pip install godice ``` -- meanwhile, to install a local copy -1. Clone the repo -2. cd into the root dir -3. Install a local copy -``` -pip install . -``` - ## Demo Package includes a demo script showing up API features. Command to run it: diff --git a/godice/__init__.py b/godice/__init__.py index 8c93688..a72b8a4 100644 --- a/godice/__init__.py +++ b/godice/__init__.py @@ -1,5 +1,5 @@ """ -GoDice Python API +Use the GoDice Python API to integrate GoDice functionality into your own Python applications """ __version__ = "0.1.0" diff --git a/pyproject.toml b/pyproject.toml index c1b20f3..286184f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,17 @@ build-backend = "flit_core.buildapi" [project] name = "godice" -authors = [{name = "Particula", email = "iavtomator@gmail.com"}] +authors = [ + {name = "Guy Levi", email = "todo_update@it.com"}, + {name = "Anton Ptashnik", email = "iavtomator@gmail.com"}, +] +license = {file = "LICENSE.md"} +classifiers = [ + "Framework :: AsyncIO", + "Operating System :: Microsoft :: Windows :: Windows 10", + "Operating System :: POSIX :: Linux", + "Operating System :: MacOS", +] readme = "README.md" dynamic = ["version", "description"] dependencies = [