added CLAUDE.md file

[puja-trivedi]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @puja-trivedi, 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 introduces a new CLAUDE.md file, designed to serve as a comprehensive guide for AI assistants like Claude Code. The file centralizes critical information about the bkbit project, covering its purpose, development setup, command-line interface usage, architectural components, and external dependencies. This addition aims to streamline the onboarding and understanding of the codebase for AI tools, thereby enhancing automated code assistance and maintenance.

Highlights

• Introduction of CLAUDE.md: A new Markdown file, CLAUDE.md, has been added to the repository. This file is specifically designed to provide comprehensive guidance and context for AI assistants like Claude Code when interacting with the codebase.
• Comprehensive Project Overview: The new file includes a detailed overview of the bkbit library, explaining its purpose as a Python library for working with BICAN Knowledgebase Data Models, including Pydantic models and tools for data translation, conversion, and editing.
• Development and Command Guides: It outlines essential development setup instructions, commands for testing, linting, and formatting, and a comprehensive list of bkbit CLI subcommands with their respective functions.
• Architectural Breakdown: The document provides a clear breakdown of the project's architecture, detailing core modules such as models, data_translators, model_converters, model_editors, and utils, along with their responsibilities.
• Dependencies and Environment Variables: Key external dependencies like LinkML, Schemasheets, and Click are documented, alongside necessary environment variables such as jwt_token, ensuring clarity for both human and AI understanding.

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 a CLAUDE.md file, which serves as a comprehensive guide for developers and AI assistants working with the bkbit repository. The file is well-structured and provides a good overview of the project, including setup, commands, architecture, and dependencies. I've identified a few minor inconsistencies and areas for improvement to enhance clarity and correctness. Overall, this is a valuable addition to the project's documentation.

[gemini-code-assist]

There's a typo in the subcommand name. Based on bkbit/cli.py and bkbit/model_converters/yaml2sheet_converter.py, the command should be yaml2csv to accurately reflect its function of converting YAML to CSV.

Suggested change

	- `bkbit yaml2cvs` - Convert YAML to CSV
	- `bkbit yaml2csv` - Convert YAML to CSV

[puja-trivedi]

the suggestion is valid and needs to be fixed; however, it would require changing the name in multiple places. Will require a separate PR

[gemini-code-assist]

The filename add_dunderMethods_genomeAnnotation.py appears to have a typo in dunderMethods. It should be dunder_methods for better readability and to follow Python's naming conventions for dunder (double underscore) methods.

Suggested change

	- `add_dunderMethods_genomeAnnotation.py` - Adds __eq__, __ne__, __hash__ to GeneAnnotation
	- `add_dunder_methods_genomeAnnotation.py` - Adds __eq__, __ne__, __hash__ to GeneAnnotation

[puja-trivedi]

the suggestion is valid (but low priority); however, it would require changing the name in multiple places. Would require a separate PR