Metadata-Version: 2.1
Name: greatapi
Version: 0.0.5
Summary: GreatAPI framework, Full stack FastAPI framework.
Home-page: https://github.com/sahajrajmalla/greatapi
Author: Sahaj Raj Malla
Author-email: mallasahajraj@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
Requires-Dist: fastapi (<0.79.0,>=0.78.0)
Requires-Dist: jinja2 (<4.0.0,>=2.11.2)
Requires-Dist: numpy (<2.0.0,>=1.18.1)
Requires-Dist: passlib[bcrypt] (<2.0.0,>=1.7.2)
Requires-Dist: pre-commit (<3.0.0,>=2.17.0)
Requires-Dist: python-jose[cryptography] (<4.0.0,>=3.3.0)
Requires-Dist: python-multipart (<0.0.6,>=0.0.5)
Requires-Dist: sqlalchemy (<1.5.0,>=1.3.18)
Requires-Dist: typer (<0.5.0,>=0.4.1)
Requires-Dist: uvicorn[standard] (<0.18.0,>=0.12.0)
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'

<div align="center">

<img src="https://raw.githubusercontent.com/sahajrajmalla/greatapi/master/greatapi/admin/static/greatapi_readme.svg" alt="GreatAPI"/>

<i>GreatAPI framework, Full-stack FastAPI framework</i>

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sahajrajmalla/greatapi/%F0%9F%8E%A8%20Linter?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dm/greatapi?color=green&style=for-the-badge)
![PyPI](https://img.shields.io/pypi/v/greatapi?style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/greatapi?style=for-the-badge)
<hr

Documentation: https://greatapi.readthedocs.io/en/latest/

Source Code: https://github.com/sahajrajmalla/greatapi

PyPI Package: https://pypi.org/project/greatapi/


<hr>
</div>

## **Contributors**
Some of the major contributors to GreatAPI are:
- [@thebrowl](https://github.com/thebrowl) -> [Admin Panel Design]
- [@lamdiv](https://github.com/lamdiv) -> [Admin Panel Development with Jinja2]
- [@Avi777](https://github.com/Avi777) -> [Consultant]
## **Requirements**

- Python 3.6+
- GreatAPI stands on the shoulders of giants:
    - FastAPI
    - uvicorn
    - typer
    - jinja2
    - SQLAlchemy

## **Installation**

```bash
pip install greatapi
```

## **Getting Started**

### ***Startproject: To create a new project***

```bash
greatapi startproject <project_name>
```

### ***Startapp: To create a new app***

```bash
greatapi startapp <app_name>
```

### ***Running: To run the server***

```bash
greatapi runserver
```
Then you can access the server at http://localhost:8000/ where you will find a beautiful built-in Admin Panel.

Afterwards, you can normally implement your API logic using FastAPI itself.

## **License**

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


