py-wlcommands 0.2.11

py_wlcommands - Python项目

py_wlcommands

py_wlcommands is a command-line toolset based on Python that provides automated command support for project development, covering common development tasks such as environment initialization, building, testing, formatting, cleaning, and code checking. The project combines Python and Rust technology stacks, demonstrating attention to performance and scalability.

Features

• init: Initialize project environment with Git, virtual environment, i18n, Rust submodule, etc.
• build: Execute build tasks, support Python package building and distribution
• test: Run project tests
• format: Support Python and Rust code formatting (integrated with black, rustfmt, etc.)
• lint: Execute code quality checks
• clean: Clean build artifacts and temporary files
• self: Self-management commands

Installation

From PyPI

pip install py-wlcommands

From Source

# Clone the repository
git clone https://github.com/wl-commands/py_wlcommands.git
cd py_wlcommands

# Install in development mode
pip install -e .

Usage

After installation, you can use the wl command:

# Show help
wl --help

# Initialize a new project
wl init

# Build the project
wl build

# Run tests
wl test

# Format code
wl format

# Lint code
wl lint

# Clean build artifacts
wl clean

# Update the tool itself
wl self update

WorkspaceDetector

The workspace detection used by wl init is provided as a reusable class WorkspaceDetector in src/py_wlcommands/utils/workspace_detector.py.

• detect(project_root: Path | None = None) -> bool: Detects whether the given root is a uv workspace using configurable rules.
• validate(project_root: Path | None = None) -> ValidationResult: Returns a simple validation result with key details about the workspace structure.
• getConfig() -> dict: Returns the active detection rules.
• resolvePath(path: str | Path, project_root: Path | None = None) -> Path: Resolves a path relative to the given workspace root.

Default detection checks:

• pyproject.toml contains tool.uv.workspace
• presence of uv.lock
• uv init --dry-run shows workspace membership message
• uv tree shows at least two root packages

Other commands can directly create and use WorkspaceDetector to query workspace state.

Development

Prerequisites

• Python >= 3.10
• Rust toolchain
• Git

Setup Development Environment

# Clone the repository
git clone https://github.com/wl-commands/py_wlcommands.git
cd py_wlcommands

# Install dependencies
pip install -e .

# Or if using uv
uv pip install -e .

Running Tests

# Run all tests
pytest tests/

# Or using the wl command
wl test

Building Distribution Packages

# Build with wl command
wl build dist

# Or directly with maturin
maturin build --release --out dist --sdist

CI/CD

This project uses GitHub Actions for continuous integration and deployment:

• CI: Runs tests on multiple platforms (Ubuntu, Windows, macOS) and Python versions (3.10, 3.11, 3.12)
• Code Quality: Runs linting and type checking
• Publish: Automatically publishes to PyPI when a new tag is pushed

License

This project is licensed under the MIT License - see the LICENSE file for details.