pytestmate 0.1.0

Generate Pytests for your project through the terminal.

PytestMate

A command-line tool for managing Python test infrastructure. PytestMate helps you set up, maintain, and run tests for your Python projects with minimal effort.

Features

• Automatic Test Structure Creation: Generate test directories and test files that mirror your project structure
• Git Integration: Use Git to track and manage Python files in your project
• Project Validation: Ensure you're working within a valid Python project
• Coming Soon:
  • Test file updates
  • Test execution
  • Test coverage reporting
  • Additional test file generation

Installation

pip install pytestmate

Usage

Initialize Test Structure

# Basic usage
ptm init

# Use Git for file discovery
ptm init --git

This command:

1. Verifies that you're in a Python project
2. Identifies Python source files
3. Creates a test directory structure
4. Generates test file placeholders

Other Commands (Coming Soon)

# Update existing test files
ptm update

# Run tests with pytest
ptm test

# Generate test coverage reports
ptm report

# Generate additional test files
ptm generate

Requirements

• Python 3.7+
• Click
• Git (optional, for Git integration)

Development

Setup

# Clone the repository
git clone https://github.com/yourusername/pytestmate.git
cd pytestmate

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

Running Tests

pytest

Contributing

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

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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

Acknowledgments

• Click for the CLI framework
• pytest for the testing framework