Skip to content

Packaging #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Packaging #9

wants to merge 6 commits into from

Conversation

nithishr
Copy link
Contributor

@nithishr nithishr commented Apr 23, 2025

  • Packaging for PyPi release
  • Lint using Ruff
  • Minor reorganization

- Added authors and classifiers to pyproject.toml for better project metadata.
…for package build and publish

- Changed version in pyproject.toml to 0.2.0-rc.0 to indicate a release candidate.
- Introduced a new GitHub Actions workflow for building and publishing the package to PyPI, including steps for linting, installation, and release creation.
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @nithishr, I'm Gemini Code Assist1! 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!

Summary of Changes

This pull request focuses on packaging and preparing the mcp-couchbase project for a release candidate. The primary changes involve updating the project metadata in pyproject.toml, including the version number, author information, classifiers, and entry point for the server application. Additionally, there are minor code improvements in src/server.py, such as reordering imports for better readability and clarifying the help text for the read_only_query_mode option. The pull request also includes minor documentation improvements in the docstrings for the get_scopes_and_collections_in_bucket and get_schema_for_collection functions.

Highlights

  • Packaging: Updates pyproject.toml to version 0.2.0-rc.0, adds author and classifier information, and defines a script entry point.
  • Code Improvements: Reorders imports in src/server.py and clarifies help text for the read_only_query_mode option.
  • Documentation: Improves docstrings for get_scopes_and_collections_in_bucket and get_schema_for_collection in src/server.py.

Changelog

Click here to see the changelog
  • pyproject.toml
    • Updates the project version to 0.2.0-rc.0.
    • Adds author information, including name and email.
    • Adds classifiers to specify the development status, programming language, and database type.
    • Adds a script entry point for the server application.
    • Configures ruff linter.
  • src/server.py
    • Reorders imports for better readability.
    • Clarifies the help text for the read_only_query_mode option.
    • Improves docstrings for get_scopes_and_collections_in_bucket to improve readability.
    • Improves docstrings for get_schema_for_collection to improve readability.
    • Adds a comment to clarify the purpose of checking for data or structure modification queries.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.


A package takes form,
Version bumps weather the storm,
Ready to deploy,
With nary a coy,
Release candidate is warm.

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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request introduces packaging improvements and updates the MCP server implementation for Couchbase. The changes include updating the project version, adding author and classifier information, defining project scripts, and setting up linting rules in pyproject.toml. Additionally, the code refactors import statements, improves help text for command-line options, and enhances documentation for MCP tools in src/server.py. Overall, the changes seem beneficial for the project.

Summary of Findings

  • Documentation improvements: The documentation for MCP tools has been improved to provide more clarity on the return values.
  • Read-only query mode help text: The help text for the --read-only-query-mode option has been updated to improve readability.
  • Import statement ordering: The import statements in src/server.py have been reordered for better readability and organization.

Merge Readiness

The pull request appears to be in good shape for merging. The changes improve the project's metadata, documentation, and code organization. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging.

@nithishr nithishr marked this pull request as ready for review April 23, 2025 16:43
- Changed the classifier from "Database :: MCP Server" to "Topic :: Database" to better categorize the project.
- Introduced a new section for wheel build targets in pyproject.toml, specifying the packages to include during the build process.
- Updated `pyproject.toml` to change the script entry point to the new module path and added a new build target for the `src/mcp_couchbase` package.
- Introduced `__init__.py` in the `src/mcp_couchbase` directory to define it as a package.
- Updated `pyproject.toml` to rename the project from "mcp-couchbase" to "mcp-server-couchbase" and adjusted the script entry point accordingly.
@nithishr nithishr marked this pull request as draft April 24, 2025 19:03
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.

1 participant