Metadata-Version: 2.4
Name: spoon-ec5fd18c
Version: 0.1.16
Summary: An experimental Python project that explores modern Python development best practices and GitHub workflows
Author: guantao.gao
Author-email: guantao.gao <guantao.gao@clickzetta.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Requires-Dist: typer-slim>=0.17.3 ; extra == 'cli'
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/czudf/spoon
Project-URL: Issues, https://github.com/czudf/spoon/issues
Project-URL: Repository, https://github.com/czudf/spoon
Provides-Extra: cli
Description-Content-Type: text/markdown

# spoon_ec5fd18c

spoon_ec5fd18c is an experimental Python project exploring
modern Python development best practices and GitHub workflows.

## Installation

You can install spoon_ec5fd18c using pip:

```bash
pip install spoon-ec5fd18c
```

To install with a CLI tool:

```bash
pip install 'spoon-ec5fd18c[cli]'
```

## Usage

### Command Line Interface

The package provides a command-line interface. After installation, run:

```bash
spoon-ec5fd18c World
```

### Python API

Import and use the library functions in your Python code:

```python
from spoon_ec5fd18c import hello

print(hello("World"))
```

## Development

### Setting up Development Environment

1. Clone the repository
2. Install development dependencies:
   ```bash
   uv sync --all-extras
   ```

### Running Tests

Run linters with:

```bash
uv run ruff format --check
uv run ruff check
uv run mypy src/
```

Run tests with:

```bash
uv run pytest tests/
```

### Building the Package

Build the package distribution:

```bash
uv build
```

### Documentation

Build the documentation:

```bash
uv run pdoc -o docs -d google spoon_ec5fd18c
```

To serve documentation locally with live reloading:

```bash
uv run pdoc -d google spoon_ec5fd18c
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Pass all linters and tests
6. Submit a pull request

## License

This project is licensed under Apache-2.0 license.

## Support

If you encounter any issues or have questions, please open an issue on the GitHub repository.

## Versioning

This project uses semantic versioning.
