template-flask


Nametemplate-flask JSON
Version 3.3 PyPI version JSON
download
home_pagehttps://github.com/zacharybeebe/template_flask
SummaryPython module for creating a template flask app structure and virtual environment, along with Bootstrap examples
upload_time2023-09-19 23:12:23
maintainer
docs_urlNone
authorZach Beebe
requires_python>=3.6
licenseMIT
keywords flask directory structure cookie cuttervenv bootstrap
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # template-flask

pip install template_flask


from the command line navigate to the directory where you would like to keep your project

type "python -m template_flask" and click enter

enter the name of your project

once completed you will have a basic flask directory structure setup and a virtual environment with these packages installed within it...

atomicwrites
attrs
blinker
click
colorama
coverage
Flask
Flask-DebugToolbar
Flask-Login
Flask-Mail
Flask-SQLAlchemy
Flask-WTF
greenlet
gunicorn
iniconfig
itsdangerous
Jinja2
MarkupSafe
packaging
pluggy
py
pyparsing
pytest
pytest-cov
SQLAlchemy
tomli
Werkzeug
WTForms


Directory structure
<your_app>

--> <your_app>_app (main app module)

    --> __init__.py (flask app configuration and imports)

    --> config
        --> __init__.py
        --> config.py

    --> models
        --> __init__.py
        --> datatypes.py
        --> db.py
        --> other_model.py
        --> user.py

    --> routes
        --> __init__.py
        --> routes.py

    --> static
        --> css
            --> bootstrap
                --> * all bootstrap example css
        --> img
        --> js
            --> bootstrap
                --> * all bootstrap example js
            fetcher.js

    --> templates
        --> bootstrap
            --> * all bootstrap example html
        --> index.html

--> venv
--> requirements.txt
--> wsgi.py (main flask app entry point)
--> Dockerfile
--> .dockerignore


Within the templates and static folders that are created, you will find HTML, CSS, and JS for various Bootstrap 5 example
if you would like to use them in your project.

To preview the live Bootstrap pages, activate your newly created virtual environment and
run the newly created "run.py" file from within your new project directory, open to
the index page and click through the buttons.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zacharybeebe/template_flask",
    "name": "template-flask",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "flask,directory structure,cookie cuttervenv,bootstrap",
    "author": "Zach Beebe",
    "author_email": "z.beebe@yahoo.com",
    "download_url": "https://files.pythonhosted.org/packages/bf/1f/eb3d8a5f5fbf6bbd32b2e4b3aeda5f99400ac9b2e9a287f766386edfa8ac/template_flask-3.3.tar.gz",
    "platform": null,
    "description": "# template-flask\r\n\r\npip install template_flask\r\n\r\n\r\nfrom the command line navigate to the directory where you would like to keep your project\r\n\r\ntype \"python -m template_flask\" and click enter\r\n\r\nenter the name of your project\r\n\r\nonce completed you will have a basic flask directory structure setup and a virtual environment with these packages installed within it...\r\n\r\natomicwrites\r\nattrs\r\nblinker\r\nclick\r\ncolorama\r\ncoverage\r\nFlask\r\nFlask-DebugToolbar\r\nFlask-Login\r\nFlask-Mail\r\nFlask-SQLAlchemy\r\nFlask-WTF\r\ngreenlet\r\ngunicorn\r\niniconfig\r\nitsdangerous\r\nJinja2\r\nMarkupSafe\r\npackaging\r\npluggy\r\npy\r\npyparsing\r\npytest\r\npytest-cov\r\nSQLAlchemy\r\ntomli\r\nWerkzeug\r\nWTForms\r\n\r\n\r\nDirectory structure\r\n<your_app>\r\n\r\n--> <your_app>_app (main app module)\r\n\r\n    --> __init__.py (flask app configuration and imports)\r\n\r\n    --> config\r\n        --> __init__.py\r\n        --> config.py\r\n\r\n    --> models\r\n        --> __init__.py\r\n        --> datatypes.py\r\n        --> db.py\r\n        --> other_model.py\r\n        --> user.py\r\n\r\n    --> routes\r\n        --> __init__.py\r\n        --> routes.py\r\n\r\n    --> static\r\n        --> css\r\n            --> bootstrap\r\n                --> * all bootstrap example css\r\n        --> img\r\n        --> js\r\n            --> bootstrap\r\n                --> * all bootstrap example js\r\n            fetcher.js\r\n\r\n    --> templates\r\n        --> bootstrap\r\n            --> * all bootstrap example html\r\n        --> index.html\r\n\r\n--> venv\r\n--> requirements.txt\r\n--> wsgi.py (main flask app entry point)\r\n--> Dockerfile\r\n--> .dockerignore\r\n\r\n\r\nWithin the templates and static folders that are created, you will find HTML, CSS, and JS for various Bootstrap 5 example\r\nif you would like to use them in your project.\r\n\r\nTo preview the live Bootstrap pages, activate your newly created virtual environment and\r\nrun the newly created \"run.py\" file from within your new project directory, open to\r\nthe index page and click through the buttons.\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python module for creating a template flask app structure and virtual environment, along with Bootstrap examples",
    "version": "3.3",
    "project_urls": {
        "Homepage": "https://github.com/zacharybeebe/template_flask"
    },
    "split_keywords": [
        "flask",
        "directory structure",
        "cookie cuttervenv",
        "bootstrap"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d38a7b9483b5d36cd88bf497649a4568cdbf1e212c85cd217a7f9310e8aa671c",
                "md5": "156f284383eb9ae5df7a249b4b77a247",
                "sha256": "10ce73aaf50c2cd5fe33ca7d16f85fd3054668da328cb0f40dd7716bca6e3c1d"
            },
            "downloads": -1,
            "filename": "template_flask-3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "156f284383eb9ae5df7a249b4b77a247",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 288915,
            "upload_time": "2023-09-19T23:12:16",
            "upload_time_iso_8601": "2023-09-19T23:12:16.642345Z",
            "url": "https://files.pythonhosted.org/packages/d3/8a/7b9483b5d36cd88bf497649a4568cdbf1e212c85cd217a7f9310e8aa671c/template_flask-3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf1feb3d8a5f5fbf6bbd32b2e4b3aeda5f99400ac9b2e9a287f766386edfa8ac",
                "md5": "18e4ec2c59b5352ef4d76dd1821139f6",
                "sha256": "c4daf65e4de1cbb218c6141fe5324f810319e7ed5d36c3ae31e6380589a399c7"
            },
            "downloads": -1,
            "filename": "template_flask-3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "18e4ec2c59b5352ef4d76dd1821139f6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 2263720,
            "upload_time": "2023-09-19T23:12:23",
            "upload_time_iso_8601": "2023-09-19T23:12:23.935086Z",
            "url": "https://files.pythonhosted.org/packages/bf/1f/eb3d8a5f5fbf6bbd32b2e4b3aeda5f99400ac9b2e9a287f766386edfa8ac/template_flask-3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-19 23:12:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zacharybeebe",
    "github_project": "template_flask",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "template-flask"
}
        
Elapsed time: 0.16049s