-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Problem
The current package name pysdl conflicts with existing PyPI packages:
This naming conflict causes confusion and prevents us from publishing to PyPI under the current name.
Required Changes
The following components need to be updated:
1. Package Structure
- Rename
pysdl/directory to[NEW_NAME]/ - Update
pyproject.tomlpackage name and metadata - Update
setup.pyif present
2. Import Statements
- Update all
from pysdl import ...statements throughout codebase - Update
__init__.pyimports - Search and replace in all Python files
3. Documentation
- Update README.md with new package name
- Update installation instructions
- Update code examples and usage documentation
- Update API documentation
- Update any tutorials or guides
4. Configuration Files
- Update GitHub workflows (
.github/workflows/) - Update test configurations
- Update CI/CD pipeline references
- Update
.gitignoreif package name is referenced
5. Tests
- Update import statements in test files
- Update test configuration files
- Verify all tests pass after rename
6. Repository Metadata
- Update repository description
- Update badges in README
- Update PyPI classifier metadata
- Update repository topics/tags
Suggested Alternative Names
Consider these options that clearly indicate the async/actor model focus:
async-sdl- Clear async indicator, dash-separatedasyncsdl- Compact, follows async library naming conventionssdl-actor- Emphasizes the actor model implementationactor-sdl- Alternative actor-focused namepysdl-async- Extends original name with async suffixsdl-async- Clean and descriptive
Migration Path
For existing users (if any):
- Publish final version under
pysdlwith deprecation warning - Publish new version under
[NEW_NAME]with migration guide - Document the migration process in CHANGELOG.md
- Consider creating a legacy
pysdlpackage that re-exports from[NEW_NAME]temporarily
Notes
- This is a breaking change requiring a major version bump
- Should be done before any significant user adoption
- Consider creating a migration checklist issue template
- Update CHANGELOG.md with migration instructions
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request