sample-wolf 0.1.0
A sample Python package
Requires Python: >=3.8


# Wolf-Py

## Overview

Wolf-Py is a Python command-line tool designed to generate standardized Python package structures. It automates the creation of complete Python packages with all necessary files, following modern Python packaging standards and best practices.

## System Architecture

### Core Architecture
- **Language**: Python 3.8+
- **Distribution**: PyPI package installable via pip
- **Entry Point**: Console script accessible as `wolf-py` command
- **Structure**: Simple CLI tool with template-based file generation

### Key Design Decisions
- **Template-based approach**: Uses string templates for file generation to ensure consistency and customization
- **Setuptools integration**: Uses setuptools for package distribution with console script entry points
- **Modern packaging standards**: Generates pyproject.toml files following PEP 518/621 standards
- **Cross-platform compatibility**: Designed to work on all major operating systems

## Key Components

### 1. CLI Interface (`cli.py`)
- **Purpose**: Command-line argument parsing and user interaction
- **Key Features**:
  - Accepts package creation parameters (name, author, email, description, version)
  - Validates input arguments
  - Provides help and usage information

### 2. Package Generator (`generator.py`)
- **Purpose**: Core logic for creating package structures
- **Responsibilities**:
  - Creates directory structures
  - Generates files from templates
  - Handles file system operations
  - Manages template context variables

### 3. Template System (`templates.py`)
- **Purpose**: Contains all file templates as string constants
- **Included Templates**:
  - MIT License template
  - pyproject.toml configuration
  - README.md structure
  - Package __init__.py files
  - Example module and test files
  - .gitignore for Python projects

### 4. Package Entry Point (`__init__.py`)
- **Purpose**: Package metadata and version information
- **Contains**: Version, author, and description constants

## Data Flow

1. **User Input**: User runs `wolf-py -c <directory>` with optional parameters
2. **Argument Parsing**: CLI module parses and validates arguments
3. **Generator Initialization**: PackageGenerator instance created with user parameters
4. **Template Processing**: Templates populated with user-provided context
5. **File Generation**: Directory structure created and files written to filesystem
6. **Completion**: User receives feedback on successful package creation

## External Dependencies

### Runtime Dependencies
- **Python Standard Library**: pathlib, argparse, os, shutil
- **setuptools**: For package installation and console script creation

### Development Dependencies
- **setuptools**: Package building and distribution
- **Standard packaging tools**: For PyPI distribution

### Template Dependencies Generated
- **hatchling**: Modern Python build backend (specified in generated pyproject.toml)
- **Python 3.8+**: Minimum version requirement for generated packages

## Deployment Strategy

### Distribution Method
- **PyPI Package**: Distributed via Python Package Index
- **Installation**: `pip install wolf-py`
- **Console Script**: Automatically creates `wolf-py` command in user's PATH

### Package Structure
- Uses setuptools with setup.py for backward compatibility
- Console script entry point: `wolf-py=wolf_py.cli:main`
- Follows standard Python package layout with source in `wolf_py/` directory

### Generated Package Standards
- Creates modern pyproject.toml-based packages
- Includes proper directory structure (src layout optional)
- Generates MIT License by default
- Includes basic test structure and examples

## Recent Changes

✓ Wolf-Py CLI tool successfully implemented and tested
✓ Package generator creates complete Python package structures
✓ Templates system generates all required files (LICENSE, pyproject.toml, README.md, etc.)
✓ Modern packaging standards followed with pyproject.toml configuration
✓ Console script entry point working (`wolf-py` command)
✓ Added `-s/--sample` flag for creating packages with Tamil Cyber Wolf sample code
✓ Tamil function includes Cyber Wolf member check functionality
✓ Comprehensive test coverage for Tamil function with mock input/output testing
✓ Professional template system implemented with 7 specialized templates
✓ Template types: basic, tamil, web, cli, data, ml, api
✓ Flask web application template with HTML templates and REST API endpoints
✓ Machine learning template with scikit-learn integration and sample datasets
✓ Data processing template with pandas analysis and CSV handling
✓ RESTful API template with CRUD operations and health check endpoints
✓ `--list-templates` command shows all available professional templates
✓ All professional templates tested and generating working package structures



## User Preferences

Preferred communication style: Simple, everyday language.
# sample_wolf

A sample Python package

## Installation

You can install sample_wolf using pip:

```bash
pip install sample_wolf
```

## Quick Start

```python
from sample_wolf import example

# Use your package
result = example.hello_world()
print(result)
```

## Usage

Describe how to use your package here.

## Development

To contribute to this project:

1. Clone the repository
2. Install in development mode: `pip install -e .`
3. Run tests: `python -m pytest tests/`

## License

This project is licensed TO Cyber Wolf