PyPI Publishing

[claudio525]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @claudio525, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on preparing the pygmt-helper package for publishing to PyPI. The changes primarily involve adjusting the package's metadata in pyproject.toml to meet PyPI standards, specifically by updating the package name and implementing dynamic version management for more efficient releases.

Highlights

• Package Name Update: The package name in pyproject.toml has been updated from pygmt_helper to pygmt-helper to align with common PyPI naming conventions, which typically prefer hyphens over underscores for package distribution names.
• Dynamic Versioning Implementation: The project's version is now dynamically managed using setuptools_scm. This change removes the hardcoded version from pyproject.toml and enables automatic versioning based on Git tags, streamlining release processes.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/publish-PyPI.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates pyproject.toml to prepare the package for publishing on PyPI. The changes correctly switch to a standard hyphenated package name and set up dynamic versioning using setuptools-scm, which are great improvements for maintainability. However, there are a couple of critical issues in your dependencies that will prevent publishing to PyPI or cause issues for users of your package:

1. Git Dependency: requirements.txt contains a direct dependency on a git repository (qcore @ git+...). Packages published to PyPI cannot have dependencies that are not also available on PyPI.
2. Test Dependencies: requirements.txt also includes pytest and pytest-cov. These are development/testing dependencies and should not be included in the core dependencies of the package. Users of your library will be forced to install your testing tools, which is undesirable.

Both of these issues stem from using requirements.txt directly for your package dependencies. It's recommended to define your core dependencies directly in pyproject.toml under [project.dependencies] (or keep them in requirements.txt but remove the problematic ones) and move development dependencies to [project.optional-dependencies].

I've also included a suggestion to enhance how the package version is managed at runtime.

[Copilot]

Pull request overview

This PR configures the package for PyPI publishing by adding a GitHub Actions workflow and updating package metadata. The changes enable automated publishing to PyPI when releases are created, while also modernizing the versioning approach to use git tags via setuptools-scm.

• Adopts dynamic versioning using setuptools-scm instead of hardcoded versions
• Renames package from pygmt_helper to pygmt-helper (following PyPI naming conventions with hyphens)
• Updates dependency name from qcore to qcore-utils in requirements

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File	Description
.github/workflows/publish-PyPI.yml	Adds GitHub Actions workflow to build and publish package to PyPI on release or manual trigger
pyproject.toml	Updates package name to use hyphens, removes hardcoded version in favor of dynamic versioning via setuptools-scm
requirements.txt	Renames qcore dependency to qcore-utils while maintaining git repository source

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.