https://github.com/kanghyojun/flask-foil
https://github.com/kanghyojun/flask-foil
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kanghyojun/flask-foil
- Owner: kanghyojun
- License: mit
- Created: 2014-07-31T07:31:00.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-08-04T10:32:43.000Z (almost 12 years ago)
- Last Synced: 2025-04-03T22:32:55.620Z (over 1 year ago)
- Language: Python
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.ko.md
- License: LICENSE
Awesome Lists containing this project
README
flask-foil
==========
flask boilerplate 생성기.
## 설치
$ git clone https://github.com/admire93/flask-foil.git
$ cd flask-foil
$ pip install . # 또는 python setup.py install
## 개요
flask, sqlalchemy, flask-script로 구성되어있는 프로젝트를 시작해보세요.
$ foil gen
$ vim gen.ini
$ foil start
$ manager.py -c exam.cfg.py runserver
## 사용방법
우선 프로젝트를 시작하기위해서 설정파일을 생성합니다.
$ mkdir my_project
$ cd my_project
$ foil gen
현재 디렉토리에 `gen.ini`가 생성되게되는데, `gen.ini`에 정보를 채워넣어주시면됩니다. `gen.ini`는 프로젝트이름, 작성자의 이메일, 이름 등의 다양한 설정을 포함하고있습니다.
$ cat gen.ini
[foil]
project_name =
database_url =
project_root =
author_name =
author_email =
이 설정 변수들은 다음과 같은 규칙을 따릅니다.
- `project_name`은 [pep8][pep8]에 명시되어있는 규칙을 따릅니다.
- sqlalchemy의 엔진을 생성하기위해서 `database_url`는 반드시 필요합니다.
- `databalse_url` 스키마는 [URI scheme][uri]로 작성하면됩니다. (ie. `postgresql://username:password@host.com:5432/dbname`.)
- `project_root`는 반드시 `/`로 끝나야합니다. (ie. o `/Users/admire93/my_project/`, x `/Users/admire93/my_project`)
[pep8]: http://legacy.python.org/dev/peps/pep-0008/#package-and-module-names
[uri]: http://en.wikipedia.org/wiki/URI_scheme