Skip to content

ahMADASSadi/FastAPI-Admin-CLI-Tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FastAPI-Admin

Inspired by Django cli tool, FastAPI-Admin provides a well-structured, ready-to-use, and customizable interpreter tool that can make creating and maintaining FastAPI projects like a piece of Cake 🍰.

Note: The project has not yet been deployed on the PyPI for online installation, so you'll need to clone it and then install it using pip install —e . or any other method you choose.

After installation, you are all set to use it:

Usage

At the moment, only two main below commands are implemented:

0. List the commands

To see the existing commands you can simply run fact or fact list. This command will return a list of commands that are available. for example:

startapp: start a new app

1. Creating a new project

To create a new project you only need simply to call:

fact startproject [project_name] [project_directory]
  • project_name: It's the name of your desired project and will create two sub-directories containing the main structure and necessary files.

  • project_directory: Just the directory you want to start your project in!

Below is an example you might find usefull:

fact startproject lets_rock .

The command above will start and create a project named "lets_rock" in the directory of "." which is the current working directory. note that the "." is not necessary and its the default directory value.

2. Creating a new app

To create a new app you only need simply to call:

fact startapp [app_name] [app_directory]
  • app_name: It's the name of your desired project and will create two sub-directories containing the main structure and necessary files.

  • app_directory: Just the directory you want to start your project in!

Below is an example you might find usefull:

fact startapp queen 

The command above will create an app named "queen" in the current working directory. Note that for this command to work, you must already created a project and run it in the same directory as the manage.py file is.

About

FACT, as fast as FastAPI 🔥. A User Friendly CLI tool for FastAPI

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages