Skip to content
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.

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

Enable to install tome via pip #14

Merged
merged 5 commits into from
Apr 2, 2023
Merged

Enable to install tome via pip #14

merged 5 commits into from
Apr 2, 2023

Conversation

mkshing
Copy link
Contributor

@mkshing mkshing commented Apr 2, 2023

@dbolya Hi, this is a PR for pip install.

related: #3

How to publish the package

To publish the package, please follow these steps.

  1. If you don't have an account in pypi, create yours in https://pypi.org/
  2. Get your API token from https://pypi.org/manage/account/.
  3. Set the token to this repository secrets and name it PYPI_API_TOKEN. Please follow https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment to create a secret in the repo.
  4. Once you set the token, you're almost ready. Create whl package on your local by running:
    $ python setup.py bdist_wheel
    $ python setup.py clean --all
    And, you will see a whl package tomesd-0.1-py3-none-any.whl in dist folder.
  5. Release your v0.1 via https://github.com/mkshing/dbolya/releases. (see the following image as a example) You can attach the whl package there!
    image
  6. Done! Github will automatically create an action to publish your package to pypi, triggered by publishat step 5. https://github.com/dbolya/tomesd/actions

@mkshing mkshing marked this pull request as ready for review April 2, 2023 06:01
@mkshing mkshing mentioned this pull request Apr 2, 2023
@mkshing
Copy link
Contributor Author

mkshing commented Apr 2, 2023

@dbolya You might additionally want to fix README.md and CHAGELOG.md. Please feel free to commit to this branch or happy to do it following your suggestion.

@dbolya
Copy link
Owner

dbolya commented Apr 2, 2023

Thanks for doing this, and thanks for the detailed guide! Looks good to me, merging now.
I'll also publish a release shortly.

@dbolya dbolya merged commit 87bcbbf into dbolya:main Apr 2, 2023
@mkshing mkshing deleted the pip-install branch April 2, 2023 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants