Metadata-Version: 2.4
Name: fasti
Version: 0.0.0.dev0
Summary: Fapi: FastAPI Project Manager
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.20.0

# Fapi — FastAPI Project Manager

Fapi is a small command-line tool to scaffold FastAPI projects.

## Description

`fapi` provides commands to create a minimal FastAPI project structure from the command line.

## Requirements

- Python 3.8 or newer
- `typer` (see `pyproject.toml` for declared dependencies)

## Installation (development)

1. Open a terminal in the repository root (the folder that contains `pyproject.toml`).
2. Install the package in editable mode for development:

```bash
py -m pip install -e .
```

This makes the `fapi` package available in your active Python environment so you can run it from any directory.

## Running the CLI

- Recommended (run as a package):

```bash
py -m fapi
```

- Alternative (run the module file directly from the project root):

```bash
py fapi\__main__.py
```

Note: Do not run `py fapi` without `-m`. The `py` launcher treats that as a file/argument and Python may not add the project parent directory to `sys.path`, which results in `ModuleNotFoundError: No module named 'fapi'`.

## Basic usage

After running `py -m fapi` you will see the CLI help and available commands. Example to scaffold a new project:

```bash
py -m fapi init my_project
```

If you installed the package in editable mode you can run the command directly:

```bash
fapi init my_project
```

## Troubleshooting

- If you see `ModuleNotFoundError: No module named 'fapi'`, either:
  - Run the CLI with `py -m fapi` from the repository root, or
  - Install the package into your environment with `py -m pip install -e .`.

## Contributing

- Open an issue or submit a pull request with improvements.

## License

- Add a license file appropriate for your project.
