Metadata-Version: 2.1
Name: Flask-BigApp
Version: 2.4.0
Summary: A Flask auto importer that allows your Flask apps to grow big.
Home-page: https://github.com/CheeseCake87/Flask-BigApp
Author: David Carmichael
Author-email: david@uilix.com
License: GNU Lesser General Public License v2.1
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask
Requires-Dist: Flask-SQLAlchemy
Requires-Dist: toml
Provides-Extra: testing
Requires-Dist: pytest>=6.0; extra == "testing"
Requires-Dist: pytest-cov>=2.0; extra == "testing"
Requires-Dist: mypy>=0.910; extra == "testing"
Requires-Dist: flake8>=3.9; extra == "testing"
Requires-Dist: tox>=3.24; extra == "testing"


# ~~Flask-BigApp~~

**🚨PROJECT HAS MOVED TO Flask-Imp🚨**

[https://github.com/CheeseCake87/flask-imp](https://github.com/CheeseCake87/flask-imp)

---

Do you have an idea for a flask extension and want to use the name 
Flask-BigApp? 

Contact me and we can discuss it.

(The name is up for grabs on the condition that your Flask extension is 
transferred to the [Pallets-Ecosystem](https://github.com/pallets-eco))

---

## What is Flask-BigApp?

Flask-BigApp's main purpose is to help simplify the importing of blueprints, resources and models.
It has a few extra features built in to help with securing pages and password authentication.

## Getting Started

### Setup.

Create a new project folder and navigate to it.

```text
# Linux
cd /path/to/project-folder

# Windows
cd C:\path	o\project-folder
```

### Create a virtual environment and activate it.

**Linux / MacOS**

```bash
python3 -m venv venv
```

```bash
source venv/bin/activate
```

**Windows**

```bash
python -m venv venv
```

```bash
.env\Scriptsctivate
```

### Install Flask-BigApp

```bash
pip install flask-bigapp
```

### Create a new project.

```bash
flask-bigapp init
```

---

## Working on this project.

### Setup.

**Create a new project folder and navigate to it in the terminal, then clone this repository.**

```bash
git clone https://github.com/CheeseCake87/Flask-BigApp.git
```

### Create a virtual environment and activate it.

**Linux / MacOS**

```bash
python3 -m venv venv
```

```bash
source venv/bin/activate
```

**Windows**

```bash
python -m venv venv
```

```bash
.env\Scriptsctivate
```

### Install the requirements.

```bash
pip install -r requirements.txt
pip install -r requirements_dev.txt
```

### Install the local version of Flask-BigApp.

```bash
pip install -e .
```

### Run the Flask app.

```bash
Flask run
```

### Run the tests.

```bash
pytest
```

### Info

The Flask app is located in the `app` folder. The tests are located in the `tests` folder.

The tests are linked to the tests blueprint located at `app/blueprints/tests`.
