fast-craftsmanship 0.2.6
Add your description here
Requires Python: >=3.12

# Fast-Craftsmanship CLI Tool

Fast-Craftsmanship is a CLI tool designed to streamline the management and scaffolding of FastAPI projects. It follows best practices to help you create a clean, consistent, and scalable project structure, whether you are starting a new project or adding features to an existing one.

📚 **Documentation**: [https://fguedes90.github.io/fast-craftsmanship/](https://fguedes90.github.io/fast-craftsmanship/)

## Features

- **Project Initialization**: Quickly scaffold a new FastAPI project with a pre-defined structure.
- **DDD Structure Generation**: Generate files for domain, service, API, repository, and tests following Domain-Driven Design principles.
- **Database Migrations**: Easily create, apply, and rollback database migrations.
- **Code Verification**: Run type checking, linting, tests, and formatting checks using a single command.
- **Extensibility**: Easily extend the CLI with custom templates and commands.

## Installation

### From PyPI

If the package is available on PyPI:

```bash
pip install fast-craftsmanship
```

### From Source

Clone the repository and install in editable mode:

```bash
git clone <repository-URL>
cd fcship
pip install -e ".[dev]"
```

## Usage

After installation, use the CLI by invoking `craftsmanship` followed by the desired command.

### Basic Commands

- **Project Initialization**
  ```bash
  craftsmanship project init <project_name>
  ```

- **Domain Generation**
  ```bash
  craftsmanship domain create <domain_name>
  ```

- **Service Layer Generation**
  ```bash
  craftsmanship service create <service_name>
  ```

- **API Endpoint Generation**
  ```bash
  craftsmanship api create <api_name>
  ```

- **Repository Implementation**
  ```bash
  craftsmanship repo create <repository_name>
  ```

- **Test File Generation**
  ```bash
  craftsmanship test create <unit|integration> <test_name>
  ```

- **Database Migrations**
  ```bash
  craftsmanship db migration <migration_name>
  craftsmanship db migrate
  craftsmanship db rollback
  ```

- **Code Verification**
  ```bash
  craftsmanship verify <all|type|lint|test|format>
  ```

### Additional

- **Version Information**
  ```bash
  craftsmanship --version
  ```

## Project Structure

When a new project is initialized, the following structure is created:

```
├── api/              # API endpoints and schemas
├── domain/           # Domain entities and interfaces
├── service/          # Service layer implementation
├── infrastructure/   # Database and external services
└── tests/            # Test suites (unit and integration)
```

## Development

### Setup

```bash
# Clone the repository
git clone <repository-URL>
cd fast-craftsmanship

# Install in development mode
make dev-install
```

### Available Commands

Run `make help` to see all available commands:

```
clean                Clean up build artifacts
check-all            Run linting and tests
dev-install          Install the package with development dependencies
docs                 Generate documentation (placeholder - add your documentation command)
format               Format code with ruff
help                 Show this help
install              Install the package
lint                 Lint code with ruff
release              Create a new release (placeholder - add your release commands)
test                 Run all tests
test-cov             Run tests with coverage report
```

## Releasing New Versions

This project uses GitHub Actions for CI/CD with semantic versioning:

1. To create a new release, go to the GitHub Actions tab and run the "Bump Version" workflow
2. Choose the version type (patch, minor, or major)
3. The workflow will:
   - Update the version in pyproject.toml
   - Commit and push the changes
   - Create a tag for the new version
   - Trigger the release workflow

## Documentation

Full documentation is available at [https://fguedes90.github.io/fast-craftsmanship/](https://fguedes90.github.io/fast-craftsmanship/).

Our documentation includes:
- Detailed command references
- Tutorials and guides
- Architecture explanations
- Development workflows
- Best practices for functional programming

To run the documentation locally:

```bash
# Install the docs dependencies
pip install -e ".[docs]"

# Serve the documentation
mkdocs serve
```

## Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch: `git checkout -b feature/my-feature`
3. Commit your changes.
4. Push your branch: `git push origin feature/my-feature`
5. Open a pull request describing your feature.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Support

If you encounter issues or have suggestions, please open an issue in the repository.

---

Happy coding with Fast-Craftsmanship! 🚀