Prepare a package for publishing #6
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anton-ptashnik
commented
Sep 17, 2023
| @@ -5,6 +5,8 @@ | |||
|
|
|||
| Use the GoDice Python API to integrate GoDice functionality into your own Python applications | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
a badge will render correctly after publishing the package
| @@ -4,7 +4,17 @@ build-backend = "flit_core.buildapi" | |||
|
|
|||
| [project] | |||
| name = "godice" | |||
| authors = [{name = "Particula", email = "iavtomator@gmail.com"}] | |||
| authors = [ | |||
There was a problem hiding this comment.
@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"} |
There was a problem hiding this comment.
@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
|
Thank you for your suggestions and work! we'll check about the licensing and see what can we do |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR intends to assist with publishing the package to PyPI by:
Initial setup to allow package publishing
2.1. Go to
Account Settings->API tokens2.2. Create a new token. Name - any, Scope - entire account
3.1. Go to the repo settings ->
Secret and Variables3.2. Create a new secret with name=PYPI_TOKEN and value=generated token
Steps to publish a package
Note these steps need to be done after the PR is merged so release is done on this original repo rather than on the fork.
Releasesof the repo2.1. Create a new version tag, v0.1.0 for the first release
2.2. Press
Generate release notes. It makes release name == tag name and puts a default description2.3. Optional. Modify the description to explain changes better if needed
2.4. Submit
Once done, GitHub starts a publish action and the package will appear on PyPI in a few seconds