Api/translate

[ewalid]

Add automated PyPI publishing and improve package documentation

Summary

This PR adds automated PyPI publishing via GitHub Actions and improves the documentation by adding explicit PyPI package links in both the README and project metadata.

Changes

🚀 Automated PyPI Publishing

• Added: .github/workflows/update-PyPi-package-rosetta-xl.yml
  • Automated workflow that triggers on GitHub release publication
  • Builds and publishes the rosetta-xl package to PyPI using Python 3.11
  • Uses secure token authentication via GitHub secrets

📚 Documentation Improvements

• Updated: README.md

  • Added explicit PyPI package link in the Installation section
  • Improves discoverability and makes it easier for users to find the package on PyPI

• Updated: pyproject.toml

  • Added PyPI URL to [project.urls] section
  • Ensures the package metadata includes the PyPI link for better package visibility

Workflow Details

The GitHub Actions workflow:

• Trigger: Publishes automatically when a GitHub release is published
• Environment: Ubuntu latest with Python 3.11
• Steps:
  1. Checks out the repository
  2. Sets up Python 3.11
  3. Installs build tools (build and twine)
  4. Builds the package using python -m build
  5. Publishes to PyPI using twine upload with API token from secrets

Prerequisites

To use this workflow, ensure that:

• PYPI_API_TOKEN secret is configured in the repository settings
• The token has appropriate permissions to upload packages to PyPI

Benefits

• ✅ Automated publishing process - no more manual uploads
• ✅ Consistent release workflow
• ✅ Reduced manual steps and potential errors
• ✅ Immediate availability of new versions on PyPI after release creation
• ✅ Better package discoverability with explicit PyPI links

Testing

• The workflow will be tested automatically when a release is published on GitHub
• Documentation changes verified locally

Related

• Part of improving the release and distribution process for rosetta-xl

---

Note

Implements automated publishing and repackaging for the CLI with clearer docs.

• CI: Adds GitHub Actions workflow /.github/workflows/update-PyPi-package-rosetta-xl.yml to build and publish rosetta-xl to PyPI on release (Python 3.11, build/twine).
• Packaging: Renames project to rosetta-xl, updates description, adds keywords/classifiers, moves web deps to dev, and excludes src/rosetta/api from wheel/sdist in pyproject.toml; adds project URLs including PyPI.
• Docs: Overhauls README.md with badges, PyPI install instructions, usage/examples, options, troubleshooting, and workflow notes.
• Legal: Adds LICENSE (MIT).

^{Written by Cursor Bugbot for commit 8aa2798. This will update automatically on new commits. Configure here.}