Skip to content

[RELEASE] version 1.0.0 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 1, 2025
Merged

[RELEASE] version 1.0.0 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5ca5dd
[TEMPLATE] update README of fastapi-default template
bnbong Feb 21, 2025
4619d13
[TEMPLATE] add fastapi-dockerized, fastapi-custom-response, fastapi-a…
bnbong Feb 25, 2025
575f555
[ADD, TEMPLATE] edit core cli operations, refactored backend module, …
bnbong Feb 27, 2025
9cab788
[ADD, TEMPLATE] fastapi-psql-orm template added, edit fastkit list-te…
bnbong Mar 1, 2025
07fa5ee
[RELEASE] 1.0.0
bnbong Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ bash scripts/lint.sh
```


### Making commits
### Making PRs

Use these tags in PR title:

Expand Down
64 changes: 50 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,16 @@ $ pip install FastAPI-fastkit

### Create a new FastAPI project workspace environment immediately

Create a new FastAPI project workspace with:
You can now start new FastAPI project really fast with FastAPI-fastkit!

Create a new FastAPI project workspace immediately with:

```console
$ fastkit startproject
Enter project name: <your-project-name>
$ fastkit init
Enter the project name: <your-project-name>
Enter the author name: <your-name>
Enter the author email: <your-email>
Enter the project description: <your-project-description>

Available Stacks and Dependencies:
MINIMAL Stack
Expand Down Expand Up @@ -90,24 +95,49 @@ Installing dependencies...

---> 100%

╭─────────────────────────────────────────────────────────────────── Success ────────────────────────────────────────────────────────────────────╮
│ ✨ Project '<your-project-name>' has been created successfully! │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭───────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────╮
│ ℹ To activate the virtual environment, run: │
│ │
│ source /<new-venv-path>/venv/bin/activate │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ Dependencies installed successfully │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ FastAPI project '<your-project-name>' has been created successfully and saved to '<your-project-path>'! │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ℹ To start your project, run 'fastkit runserver' at newly created FastAPI project directory │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

This command will create a new FastAPI project workspace environment with Python virtual environment.

### Place a structured FastAPI project immediately
### Add a new route to the FastAPI project

`FastAPI-fastkit` makes it easy to expand your FastAPI project.

Add a new route endpoint to your FastAPI project with:

```console
$ fastkit addroute <your-project-name> <new-route-name>

---> 100%

╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Info ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ℹ Updated main.py to include the API router │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Success ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ ✨ Successfully added new route '<new-route-name>' to project '<your-project-name>'. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```


### Place a structured FastAPI demo project immediately

Place a structured FastAPI project immediately with:
You can also start with a structured FastAPI demo project.

Demo projects are consist of various tech stacks with simple item CRUD endpoints implemented.

Place a structured FastAPI demo project immediately with:

```console
$ fastkit startup
$ fastkit startdemo
Enter the project name: <your-project-name>
Enter the author name: <your-name>
Enter the author email: <your-email>
Expand Down Expand Up @@ -137,6 +167,12 @@ FastAPI template project will deploy at '<your-project-path>'
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

To view the list of available FastAPI demos, check with:

```console
$ fastkit list-templates
```

## Significance of FastAPI-fastkit

FastAPI-fastkit aims to provide a fast and easy-to-use starter kit for new users of Python and FastAPI.
Expand Down
2 changes: 1 addition & 1 deletion src/fastapi_fastkit/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.1.2"
__version__ = "1.0.0"

import os

Expand Down
Loading
Loading