Skip to content

Conversation

@sukeesh
Copy link
Owner

@sukeesh sukeesh commented Feb 13, 2025

This pull request introduces a GitHub Actions workflow for automatically publishing the project to PyPI upon a new release. Additionally, it includes the MIT License for the project and updates the README to reflect new installation methods.

Changes Made:

  • GitHub Actions Workflow:

    • Added a new file .github/workflows/publish.yml that defines a workflow to publish the package to PyPI when a release is created.
    • The workflow sets up Python 3.11, installs Poetry, and uses it to build and publish the package, utilizing a secret token for authentication.
  • License:

    • Added a new LICENSE file containing the MIT License to clarify the terms of use for the project.
  • README Updates:

    • Revised the installation instructions to include:
      • Installation via pipx for all platforms.
      • An alternative installation method using Homebrew for macOS/Linux.
    • Improved clarity and organization of the installation section.

Benefits:

  • This workflow automates the publishing process, reducing manual steps and potential errors.
  • Including a license enhances the project's professionalism and informs users of their rights.
  • Updated README ensures users have clear and accessible installation options.

Please review the changes and let me know if you have any questions or need further modifications!

@sukeesh sukeesh merged commit 33b9c73 into master Feb 13, 2025
@sukeesh sukeesh deleted the sukeesh/add-pypi branch February 13, 2025 17:35
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