https://github.com/cesargodoi/startproject

Flask start project in application factories
https://github.com/cesargodoi/startproject

Last synced: about 2 months ago
JSON representation

Flask start project in application factories

• Host: GitHub
• URL: https://github.com/cesargodoi/startproject
• Owner: cesargodoi
• License: gpl-3.0
• Created: 2020-07-09T10:38:01.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-29T17:23:49.000Z (over 2 years ago)
• Last Synced: 2024-07-05T15:00:09.611Z (3 months ago)
• Language: Python
• Size: 57.6 KB
• Stars: 38
• Watchers: 6
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flask Project Builder

This script will start a new Flask project on the application factory model.      

## Structure provided

~~~sh

/

+-- /

|   +-- ext/ 

|   |   +-- site/

|   |   |   +-- __init__.py

|   |   |   +-- main.py

|   |   +-- __init__.py

|   +-- static/

|   |   +-- css/

|   |   +-- img/

|   |   +-- js/

|   +-- templates/

|   +-- __init__.py

|   +-- app.py --> project entry point

+-- tests/

|   +-- conftest.py

|   +-- test_app.py --> with 3 tests

+-- LICENCE

+-- Makefile

+-- README.md

+-- requirements.txt

+-- requirements-dev.txt

+-- setup.py

~~~

## How to use

1. Copy the file `startproject.py` to the directory where you will create the flask project.   

2. Run with the command:

~~~sh

$ python3 startproject.py your_project_name --venv --sqlal

~~~

> IMPORTANT

> - Do not use spaces in your project name.  Prefer underscores instead spaces.

> - The `--venv` argument indicates that you want to create a virtual environment.  It will be created inside the project's root folder as `.venv`.

> - The `--sqlal` argument indicates that you want to install SQLAlchemy in your project.

> - If you don't pass any arguments, they will be asked for you.   

   

In the `Makefile` file, we have some useful commands, which we use with the `make` command, such as:   

| **command**        | **what he does**                                  |

|--------------------|---------------------------------------------------|

| `make clean`       | clears the project folder                         |

| `make install`     | install our project as a package python           |

| `make install-dev` | similar to install, but with requirements-dev.txt |

| `make test`        | run tests                                         |

| `make run`         | run flask                                         |

| `make run-dev`     | run flask in the development environment          |

---

This python script was created by Cesar and Jady Godoi during [Curso de Desenvolvimento Web](http://skip.gg/curso-flask-codeshow) taught by Bruno Rocha.