Skip to content

Installation

This guide explains how to install FastAPI-fastkit.

Requirements

To use FastAPI-fastkit, you need to meet the following requirements:

  • Python: 3.12 or higher
  • Operating System: Windows, macOS, Linux supported

Installation Methods

The simplest installation method:

$ pip install FastAPI-fastkit
---> 100%
Successfully installed FastAPI-fastkit

Install Specific Version

To install a specific version:

$ pip install FastAPI-fastkit==1.0.0
---> 100%
Successfully installed FastAPI-fastkit-1.0.0

Install Development Version

To install the latest development version directly from GitHub:

$ pip install git+https://github.com/bnbong/FastAPI-fastkit.git
---> 100%
Successfully installed FastAPI-fastkit

Development Version Warning

Development versions may be unstable and are not recommended for production environments.

It's highly recommended to use a virtual environment to avoid dependency conflicts:

Using venv

$ python -m venv fastapi-env
$ source fastapi-env/bin/activate  # Linux/macOS
$ fastapi-env\Scripts\activate     # Windows
$ pip install FastAPI-fastkit

Using conda

$ conda create -n fastapi-env python=3.12
$ conda activate fastapi-env
$ pip install FastAPI-fastkit

Verify Installation

After installation, verify that FastAPI-fastkit is installed correctly:

$ fastkit --version
FastAPI-fastkit version 1.0.0

$ fastkit --help
Usage: fastkit [OPTIONS] COMMAND [ARGS]...

  FastAPI-fastkit CLI

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  addroute       Add a new route to FastAPI project
  init           Create a new FastAPI project
  list-templates List available FastAPI templates
  runserver      Start FastAPI development server
  startdemo      Create FastAPI project from template

Troubleshooting

Command not found

If you get a "command not found" error:

  1. Check if FastAPI-fastkit is installed:
$ pip show FastAPI-fastkit
  1. Check your virtual environment:
$ which python
$ which pip
  1. Reinstall FastAPI-fastkit:
$ pip uninstall FastAPI-fastkit
$ pip install FastAPI-fastkit

Permission errors

If you encounter permission errors during installation:

On Linux/macOS:

$ pip install --user FastAPI-fastkit

On Windows (Run as Administrator):

$ pip install FastAPI-fastkit

Python version compatibility

FastAPI-fastkit requires Python 3.12+. Check your Python version:

$ python --version
Python 3.12.0

If you have an older version, please upgrade Python:

  • Official Python: python.org/downloads
  • With pyenv: pyenv install 3.12.0
  • With conda: conda install python=3.12

Next Steps

Once installation is complete:

  1. Quick Start: Create your first project in 5 minutes
  2. Getting Started Tutorial: Step-by-step detailed tutorial
  3. CLI Reference: Complete command reference

Installation Tips

  • Always use virtual environments for project isolation
  • Keep FastAPI-fastkit updated to the latest version
  • Check the GitHub repository for updates and issues