Metadata-Version: 2.4
Name: fastapi-new
Version: 0.0.6
Summary: Create a new FastAPI project in one command
Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.14
Project-URL: Homepage, https://github.com/fastapi/fastapi-new
Project-URL: Documentation, https://github.com/fastapi/fastapi-new
Project-URL: Repository, https://github.com/fastapi/fastapi-new
Project-URL: Issues, https://github.com/fastapi/fastapi-new/issues
Project-URL: Changelog, https://github.com/fastapi/fastapi-new/release-notes.md
Requires-Python: >=3.10
Requires-Dist: typer>=0.16.0
Requires-Dist: rich>=13.7.1
Requires-Dist: typing-extensions>=4.12.2
Requires-Dist: rich-toolkit>=0.15.1
Description-Content-Type: text/markdown

# fastapi-new

Create a new FastAPI project in one command. ✨

<a href="https://github.com/fastapi/fastapi-new/actions?query=workflow%3ATest+event%3Apush+branch%3Amain" target="_blank">
    <img src="https://github.com/fastapi/fastapi-new/actions/workflows/test.yml/badge.svg?event=push&branch=main" alt="Test">
</a>
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/fastapi-new" target="_blank">
    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/fastapi-new.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/fastapi-new" target="_blank">
    <img src="https://img.shields.io/pypi/v/fastapi-new?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypi.org/project/fastapi-new" target="_blank">
    <img src="https://img.shields.io/pypi/pyversions/fastapi-new.svg?color=%2334D058" alt="Supported Python versions">
</a>

## How to use

Install [uv](https://docs.astral.sh/uv/getting-started/installation/) following their guide for your system.

Run:

```bash
uvx fastapi-new awesomeapp
```

This will create a new project `awesomeapp` with a basic FastAPI app, configured with uv.

Enter the directory:

```bash
cd awesomeapp
```

Run the development server:

```bash
uv run fastapi dev
```

Open your browser and go to `http://localhost:8000` to see your new FastAPI app running! 🚀

### Existing directory

If you want to create a new FastAPI project in an existing directory, run the command without a project name:

```bash
uvx fastapi-new
```

## License

This project is licensed under the terms of the MIT license.
