Rename project from 'struct' to 'structkit'#121
Merged
Conversation
…nflict - Update package name in pyproject.toml to 'structkit' - Update CLI entry point from 'struct' to 'structkit' - Update repository URLs to point to structkit - Update MCP server name to 'structkit-mcp-server' - Update Docker Compose service names - Update all string references throughout project
There was a problem hiding this comment.
Pull Request Overview
This PR renames the project from struct to structkit to resolve a naming conflict with Python's built-in struct module that was preventing PyPI uploads.
Key Changes:
- Updated package name and CLI entry point from
structtostructkit - Renamed MCP server from
struct-mcp-servertostructkit-mcp-server - Updated all repository URLs and documentation references
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated package name, CLI entry point, and repository URLs to structkit |
| struct_module/main.py | Changed CLI program name to structkit |
| struct_module/mcp_server.py | Renamed MCP server to structkit-mcp-server |
| docs/mcp-integration.md | Updated all command references and examples to use structkit |
| docker-compose.yaml | Renamed Docker Compose services to use structkit prefix |
- Rename struct_module folder to structkit using git mv - Update all imports and references throughout project - Update pyproject.toml package configuration - Update Docker Compose entry points - Update all documentation and config files
- Update mcp_server.py to check for both 'struct' (original config key) and 'structkit' (new package name) - Maintains backwards compatibility with existing YAML configurations - Fixes failing test: test_mcp_get_structure_info_rich_rendering
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #121 +/- ##
=======================================
Coverage 68.72% 68.72%
=======================================
Files 20 20
Lines 1554 1554
Branches 279 279
=======================================
Hits 1068 1068
Misses 411 411
Partials 75 75 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Replace all 'STRUCT' text references with 'StructKit' in documentation - Update CLI command examples from 'struct' to 'structkit' - Rename environment variables: - STRUCT_LOG_LEVEL → STRUCTKIT_LOG_LEVEL - STRUCT_HTTP_TIMEOUT → STRUCTKIT_HTTP_TIMEOUT - STRUCT_HTTP_RETRIES → STRUCTKIT_HTTP_RETRIES - STRUCT_DENY_NETWORK → STRUCTKIT_DENY_NETWORK - STRUCT_STRUCTURES_PATH → STRUCTKIT_STRUCTURES_PATH - Rename constants: BASIC_STRUCT_YAML → BASIC_STRUCTKIT_YAML - Update all documentation files, README, and code comments - All 114 tests passing
- Add blank lines after headings (H3, H4) before lists - Change code block language from bare backticks to 'text' - Ensure proper spacing between headings and content - Fixes markdown formatting for better readability and linter compliance
- Update devcontainer configuration - Update GitHub workflows and instructions - Update all documentation files with StructKit references - Update website assets and styling - Update vhs demo scripts - Complete branding update across all materials
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Rename the project from
structtostructkitto avoid conflicts with the Python Standard Librarystructmodule.Changes
pyproject.tomltostructkitstructtostructkitstructkit-mcp-serverWhy
The current package name
structconflicts with Python's built-instructmodule, causing PyPI upload failures.Testing
Please verify:
pip install structkitstructkit --helpstructkit mcp