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

docs: Prepare for PyPI upload #204

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Conversation

SoloSynth1
Copy link
Collaborator

@SoloSynth1 SoloSynth1 commented Jun 25, 2024

This PR:

  • Update poetry.lock
  • Adds and revises documentations related to PyPI release
  • Fixes broken link to image in README.md

fixml has been released on PyPI with version 0.1.0: https://pypi.org/project/fixml/

Closes #151.

@SoloSynth1 SoloSynth1 self-assigned this Jun 25, 2024
@SoloSynth1 SoloSynth1 linked an issue Jun 25, 2024 that may be closed by this pull request
@SoloSynth1 SoloSynth1 mentioned this pull request Jun 25, 2024
Copy link
Collaborator

@JohnShiuMK JohnShiuMK left a comment

Choose a reason for hiding this comment

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

@SoloSynth1 although it's mentioned earlier in the "Important" about setting the API key, i think it's better to explicitly have a instruction for that, in case people (like what Tiffany did last time) just try to copy and paste to follow the instruction.

@JohnShiuMK
Copy link
Collaborator

@SoloSynth1 fyi, I've removed the $ in the instruction.

Copy link
Collaborator

@JohnShiuMK JohnShiuMK left a comment

Choose a reason for hiding this comment

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

looks good to me thanks

@JohnShiuMK JohnShiuMK merged commit ce2f624 into main Jun 26, 2024
2 checks passed
@JohnShiuMK JohnShiuMK deleted the 151-prepare-package-for-pypi-fixml branch June 26, 2024 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants