<p align="center" class="logo">
<img src=".\docs\logo.png" alt="logo" >
</p>
<p align="center" class="name">
FastGen
</p>
<p align="center" class="slogan"> <em>A CLI for your next FastAPI Project</em></p>
<!-- <style>
.slogan{
margin-top:-9px;
padding-bottom:15px;
font-size:15px
}
.logo{
padding-bottom:10px;
padding-top:25px
}
.name{
font-size:20px;
font-weight:bold
}
</style> -->
---
<!-- # ⚡ _**FastGen**_
Start FastAPI Projects in Lightning Speed.
Built With **Typer** To Help With <span style="color:green">**FastAPI**</span>.... -->
## 👀 **Take A Look**
this is a glanc of the project structure you will have once you use **FastGen**
## **Navigate Quickly**
[installation](#✨-installation)<br>
[commands](#🧭-commands)
- [info](#fastgen-info)
- [new](#fastgen-new)
- [g](#fastgen-g)
## ✨ **Installation**
Using pip :
```console
$ python -m pip install fastgen
```
Using Poetry :
```console
$ poetry add fastgen
```
## 🧭 **Commands**
**Usage**:
```console
$ fastgen [OPTIONS] COMMAND [ARGS]...
```
**Options**:
- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.
**Commands**:
- `info`
- `new`
## **`fastgen info`**
**Usage**:
```console
$ fastgen info [OPTIONS]
```
**Options**:
- `--help`: Show this message and exit.
## **`fastgen new`**
**Usage**:
```console
$ fastgen new [OPTIONS] ⭐ Project Name
```
**Arguments**:
- `⭐ Project Name`: <span style="color:pink">**required**
**Options**:
- `--dir 📁 Directory Path`
- `--package-manager 📦 Package Manager`: [default: pip]
( Options are pip , poetry )
- `--migrations / --no-migrations`: [default: False]
- `--docker / --no-docker`: [default: False]
- `--testing / --no-testing`: [default: False]
- `--database 📅 Database`: [default: postgresql] ( Options are postgresql,mysql,sqlite )
- `--orm ⚙️ ORM`: [default: False]
- `--help`: Show this message and exit.
## **`fastgen g`**
**Usage**:
```console
$ fastgen g [OPTIONS] <component> <component_name>
```
**Available Components**
| Component | In stock |
|--------------|------------|
| router | generates new rotuer at app/api/routers |
| model | generates new sqlmodel or sqlalchemy mode at app/database/models |
| schema | generates new pydantic schema at app/api/schemas
**Options**
- `--model-type` : available only for model components , optional values are ( sqlmodel , sqlalchemy )
- `--path` : specifiy where to create the component **RELATIVE TO THE CURRENT WORKING DIRECOTRY** if not in default path
- **Note** : the naming is preferred to be in lower case so it can be resolved correctly
**Arguments**
```console
```
## 🪲 **Encountered A Problem !**
feel free to open an issue discussing the problem you faced
## 🤝🏻 **Contributing**
please refer to [Contribution Guide](./CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/kareemmahlees/fastgen",
"name": "fastgen",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "CLI,python,typer,fastapi,fastgen,project,template,pip,poetry",
"author": "kareem",
"author_email": "kareemmahlees@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0c/db/bc61669e1cd3fa375827d10ed391daff2c070eb30bbe93c7421f994fad44/fastgen-0.3.5.tar.gz",
"platform": null,
"description": "<p align=\"center\" class=\"logo\">\n<img src=\".\\docs\\logo.png\" alt=\"logo\" >\n</p>\n\n<p align=\"center\" class=\"name\">\nFastGen\n</p>\n\n<p align=\"center\" class=\"slogan\"> <em>A CLI for your next FastAPI Project</em></p>\n\n<!-- <style>\n .slogan{\n margin-top:-9px;\n padding-bottom:15px;\n font-size:15px\n }\n .logo{\n padding-bottom:10px;\n padding-top:25px\n }\n .name{\n font-size:20px;\n font-weight:bold\n }\n</style> -->\n\n---\n\n<!-- # \u26a1 _**FastGen**_\n\nStart FastAPI Projects in Lightning Speed.\n\nBuilt With **Typer** To Help With <span style=\"color:green\">**FastAPI**</span>.... -->\n\n## \ud83d\udc40 **Take A Look**\n\nthis is a glanc of the project structure you will have once you use **FastGen**\n\n\n\n## **Navigate Quickly**\n\n[installation](#\u2728-installation)<br>\n[commands](#\ud83e\udded-commands)\n\n- [info](#fastgen-info)\n- [new](#fastgen-new)\n- [g](#fastgen-g)\n\n## \u2728 **Installation**\n\nUsing pip :\n\n```console\n$ python -m pip install fastgen\n```\n\nUsing Poetry :\n\n```console\n$ poetry add fastgen\n```\n\n## \ud83e\udded **Commands**\n\n**Usage**:\n\n```console\n$ fastgen [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n- `--install-completion`: Install completion for the current shell.\n- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n- `--help`: Show this message and exit.\n\n**Commands**:\n\n- `info`\n- `new`\n\n## **`fastgen info`**\n\n**Usage**:\n\n```console\n$ fastgen info [OPTIONS]\n```\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## **`fastgen new`**\n\n**Usage**:\n\n```console\n$ fastgen new [OPTIONS] \u2b50 Project Name\n```\n\n**Arguments**:\n\n- `\u2b50 Project Name`: <span style=\"color:pink\">**required**\n\n**Options**:\n\n- `--dir \ud83d\udcc1 Directory Path`\n- `--package-manager \ud83d\udce6 Package Manager`: [default: pip]\n ( Options are pip , poetry )\n- `--migrations / --no-migrations`: [default: False]\n- `--docker / --no-docker`: [default: False]\n- `--testing / --no-testing`: [default: False]\n- `--database \ud83d\udcc5 Database`: [default: postgresql] ( Options are postgresql,mysql,sqlite )\n- `--orm \u2699\ufe0f ORM`: [default: False]\n- `--help`: Show this message and exit.\n\n## **`fastgen g`**\n\n**Usage**:\n\n```console\n$ fastgen g [OPTIONS] <component> <component_name>\n```\n\n**Available Components**\n| Component | In stock |\n|--------------|------------|\n| router | generates new rotuer at app/api/routers |\n| model | generates new sqlmodel or sqlalchemy mode at app/database/models |\n| schema | generates new pydantic schema at app/api/schemas\n\n**Options**\n\n- `--model-type` : available only for model components , optional values are ( sqlmodel , sqlalchemy )\n- `--path` : specifiy where to create the component **RELATIVE TO THE CURRENT WORKING DIRECOTRY** if not in default path\n\n- **Note** : the naming is preferred to be in lower case so it can be resolved correctly\n\n**Arguments**\n\n```console\n\n```\n\n## \ud83e\udeb2 **Encountered A Problem !**\n\nfeel free to open an issue discussing the problem you faced\n\n## \ud83e\udd1d\ud83c\udffb **Contributing**\n\nplease refer to [Contribution Guide](./CONTRIBUTING.md)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI for your next FastAPI project",
"version": "0.3.5",
"split_keywords": [
"cli",
"python",
"typer",
"fastapi",
"fastgen",
"project",
"template",
"pip",
"poetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "41c9b50624baffd5fbf88261f4136f64",
"sha256": "3f45a79705c9d538b83a45bd37fbcd713d951d8b23b1c63a3baf1a9bc3653e12"
},
"downloads": -1,
"filename": "fastgen-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41c9b50624baffd5fbf88261f4136f64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 17252,
"upload_time": "2022-12-15T14:03:51",
"upload_time_iso_8601": "2022-12-15T14:03:51.996594Z",
"url": "https://files.pythonhosted.org/packages/64/03/b1d1048662e2081d21010d239480989ad3523fb5ba13a48cd3e88ca38edf/fastgen-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "9a273b6f76cfd9bde8095486c3903692",
"sha256": "6692971c7fc424936c37b913f14b14c3e51da598db56d024375d9401601a7f6d"
},
"downloads": -1,
"filename": "fastgen-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "9a273b6f76cfd9bde8095486c3903692",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 12192,
"upload_time": "2022-12-15T14:03:53",
"upload_time_iso_8601": "2022-12-15T14:03:53.321422Z",
"url": "https://files.pythonhosted.org/packages/0c/db/bc61669e1cd3fa375827d10ed391daff2c070eb30bbe93c7421f994fad44/fastgen-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-15 14:03:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kareemmahlees",
"github_project": "fastgen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fastgen"
}
JSON
