Add more details for pypi and Github

[bjester]

Summary

• Adds more details to project config for pypi
• Updates README with more info
• Updates release workflow to upload PEX artifact

[gemini-code-assist]

Summary of Changes

Hello @bjester, 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 enhancing the project's public-facing information and distribution readiness. It updates the project configuration to provide richer metadata for PyPI, making the package more informative and discoverable. Concurrently, the project's README has been significantly expanded to offer clearer installation instructions, a detailed feature overview, and important disclosures, thereby improving the overall user experience and project transparency.

Highlights

• PyPI Metadata Enhancement: Updated pyproject.toml to include comprehensive metadata such as license, keywords, classifiers, and project URLs, improving the project's discoverability and information on PyPI.
• Documentation Improvement: The README.md was significantly updated with a new 'Quick Start' guide, a detailed 'Overview' of features, an 'AI Disclosure' statement, and license information, making it easier for new users to get started and understand the project.
• PEX Artifact Reference: The README.md now references downloading a PEX file from the releases page, indicating an update to the release workflow to include PEX artifact generation and distribution.

Changelog

• README.md
  • Updated the gh dependency link to include its URL.
  • Added a 'Quick Start' section with pip install, uvx, and PEX download instructions.
  • Introduced an 'Overview' section, detailing 'Features' and 'Details' of the tool.
  • Added an 'AI Disclosure' section to clarify the use of LLMs in development.
  • Included a 'License' section at the end of the document.
• pyproject.toml
  • Incremented the project version from 0.1.0 to 0.1.1.
  • Added the license field specifying 'MIT'.
  • Included a list of keywords for better searchability.
  • Added a comprehensive list of classifiers for PyPI.
  • Defined project.urls for Homepage, Repository, and Issues.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/release.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. ↩

[github-actions]

🎉 Build Assets are ready!

File	Checksum
gh_worktree-0.1.1-py3-none-any.whl	``
gh-worktree.pex	``

[gemini-code-assist]

Code Review

The pull request successfully adds essential metadata for PyPI and improves the documentation with a Quick Start guide and feature overview. These changes are important for the project's visibility and usability. I have identified a few issues regarding the pyproject.toml configuration, specifically an invalid classifier that would prevent successful publication to PyPI, and some minor improvements for the README's formatting and consistency.