Skip to content

Prepare a package for publishing #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Prepare a package for publishing #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
12 changes: 2 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a badge will render correctly after publishing the package


**Supported features:**

* Turn ON/OFF GoDice RGB LEDs
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion godice/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"

Expand Down
12 changes: 11 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ build-backend = "flit_core.buildapi"

[project]
name = "godice"
authors = [{name = "Particula", email = "iavtomator@gmail.com"}]
authors = [
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Geek5510 please update/extend authors list as needed. I recognize my work was based on knowledge of others about device API

{name = "Guy Levi", email = "todo_update@it.com"},
{name = "Anton Ptashnik", email = "iavtomator@gmail.com"},
]
license = {file = "LICENSE.md"}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Geek5510 I'm not strong in licensing but I'm almost sure a published package should have a correct one. I see the repo has some custom license while open source projects usually have MIT or similar one.
Please review if the current license still fits and make changes if needed

classifiers = [
"Framework :: AsyncIO",
"Operating System :: Microsoft :: Windows :: Windows 10",
"Operating System :: POSIX :: Linux",
"Operating System :: MacOS",
]
readme = "README.md"
dynamic = ["version", "description"]
dependencies = [
Expand Down