⚙️ feat(ci): improvements ⚙️

[alkalescent]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @alkalescent, 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 significantly enhances the project's development experience and maintainability by introducing comprehensive documentation, automating version management, and integrating static type checking. These changes aim to streamline onboarding for new contributors, ensure consistent versioning, and improve code quality through early detection of type-related issues. Minor code refactorings also contribute to overall clarity and robustness.

Highlights

• New Documentation: Introduced AGENTS.md to provide a comprehensive overview of the project, including its purpose, CI checks, local development instructions, project structure, and key conventions.
• Automated Versioning: Configured pyproject.toml to use hatch-vcs for dynamic versioning based on Git tags, automatically generating _version.py.
• Type Checking Integration: Added ty as a development dependency and integrated it into the Makefile with a new type target for static type analysis.
• Code Clarity and Type Safety: Applied minor refactorings across src/interstellar/cli.py and src/interstellar/tools.py to improve readability, add type hints, and enhance type safety, including explicit type casting and variable renaming.
• Test Suite Enhancements: Updated test files (tests/conftest.py, tests/test_cli.py, tests/test_tools.py) with type hints for better maintainability and clarity.
• Build Configuration Updates: Modified uv.lock to reflect the new ty dependency and adjusted pyproject.toml to exclude the auto-generated version file from Ruff linting.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .gitignore
  • Added src/interstellar/_version.py to ignore auto-generated version file.
• AGENTS.md
  • Added new file detailing project overview, CI checks, local commands, structure, and conventions.
• Makefile
  • Added type target for running ty type checker.
  • Updated .PHONY list to include the new type target.
• pyproject.toml
  • Added hatch-vcs to build requirements.
  • Configured dynamic versioning using hatch-vcs and specified _version.py as the version file.
  • Added ty to development dependencies.
  • Excluded _version.py from Ruff linting.
  • Added [tool.ty] configuration for Python version.
• src/interstellar/cli.py
  • Formatted typer.BadParameter messages for improved readability.
  • Refactored reconstruct function to use clearer variable names (share_groups, reconstructed_parts) and added type annotations.
• src/interstellar/tools.py
  • Added explicit bytes cast in BIP39.deconstruct.
  • Renamed variables and added assert statements for clarity and type safety in BIP39.eth, BIP39.generate, SLIP39.deconstruct, SLIP39.reconstruct, SLIP39.eth, and SLIP39.generate.
• tests/conftest.py
  • Added type hints to assert_eth_addr function parameters and return type.
• tests/test_cli.py
  • Added type hints to test methods and helper functions.
  • Adjusted CLI command formatting for readability.
• tests/test_tools.py
  • Added type hints to test methods for better code quality.
• uv.lock
  • Removed explicit version for interstellar package.
  • Added ty package as a development dependency with its associated wheels.

Ignored Files

• Ignored by pattern: .github/workflows/** (3)
  • .github/workflows/pr.yml
  • .github/workflows/release.yml
  • .github/workflows/test.yml

Activity

• No activity has been recorded for this pull request yet.

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 introduces several valuable improvements to the project. It sets up dynamic versioning with hatch-vcs, integrates the ty type checker into the development workflow, and enhances the test suite with type annotations for better static analysis. The code has been refactored for clarity, particularly in the reconstruct command, and several typing-related correctness fixes have been applied. Overall, these changes significantly improve the project's maintainability and robustness. I have a couple of minor suggestions to remove some redundant code for improved clarity.

[github-actions]

📦 Version Preview

• Current version: v1.2.1
• Bump type: pre-patch
• Release version: v1.2.2
• TestPyPI version: v1.2.2-rc.0

When this PR is merged, version will be bumped to v1.2.2.

To change the bump type, include in commit message: #major, #minor, or #patch