flaskey


Nameflaskey JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/usmanmusa1920/flaskey
SummaryAn extension of flask web framework of python that erase the complexity of constructing flask project blueprint, packages, and other annoying stuffs
upload_time2022-12-29 14:25:28
maintainer
docs_urlNone
authorUsman Musa
requires_python
license
keywords flaskey
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
       ____             _        __
      /___  /    /|   /_  /    /    \/
     /     /    /_|    / /_/  /__   /
    /     /___ /  | /_/ /  / /__   /

# flaskey

An extension of flask web framework of python that erase the complexity of constructing flask project blueprint, packages, and other annoying stuffs

# How to use the library
First create a virtual environment `python3 -m venv venv` and then activate it `source venv/bin/activate`

Once that finish now install the library using `pip install flaskey` and wait for the installation basically the library was uploaded using `sdist` (Source Distribution)

## Create flask project
After the installation paste the following command on your termianl

`python3 -c "from flaskey import project; project('flaskey_todo')"`

or create a file and paste the below codes which is equivalent of the above, and then run the file

```python
from flaskey import project

project("flaskey_todo")
```

the command/code will create a project called `flaskey_todo` now cd into the `flaskey_todo` directory.

## Create flask project app
For you to start an app within your project (`flaskey_todo`), run the following command

`python3 thunder.py create_app -a todo_app`

this will create an app within your project (`flaskey_todo`), the `-a` flag is for the app name in this example it is called `todo_app`

## Run flask server
once the app is created open the `thunder.py` file of your project and import your app `views.py` file

`from todo_app.views import todo_app`

after that, register it to the blueprint template by

`app.register_blueprint(todo_app)`

once you register the app, boot up the flask webser by

`python thunder.py boot`

This will bring the flask development server on port `5000` you can give it a different port by including a `-p` flag which is for port number:

`python thunder.py boot -p 7000`

this will bring the serve on port `7000` visit the localhost url with the port number, it will show you your project `index.html page` (flaskey_todo). To get to your app page (todo_app), visit the url with your app name e.g

`http://127.0.0.1:7000/todo_app`

this will take you to your app `index.html page` (todo_app). From there you are ready to go.

# Disclaimer
This software will not be compatible with `windows operating system` use other `OS` such as `linux` or `macOS`

## Github repository:

- https://github.com/usmanmusa1920/flaskey

Pull requests are welcome


Change Log
==========

0.0.1 (29/december/2022)
------------------
- First Release

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/usmanmusa1920/flaskey",
    "name": "flaskey",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "flaskey",
    "author": "Usman Musa",
    "author_email": "usmanmusa1920@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e6/7e/4bd1afffe99d12b037e820644af040153d112318c3886ff1fd3118e9f1b4/flaskey-0.0.1.tar.gz",
    "platform": null,
    "description": "\n       ____             _        __\n      /___  /    /|   /_  /    /    \\/\n     /     /    /_|    / /_/  /__   /\n    /     /___ /  | /_/ /  / /__   /\n\n# flaskey\n\nAn extension of flask web framework of python that erase the complexity of constructing flask project blueprint, packages, and other annoying stuffs\n\n# How to use the library\nFirst create a virtual environment `python3 -m venv venv` and then activate it `source venv/bin/activate`\n\nOnce that finish now install the library using `pip install flaskey` and wait for the installation basically the library was uploaded using `sdist` (Source Distribution)\n\n## Create flask project\nAfter the installation paste the following command on your termianl\n\n`python3 -c \"from flaskey import project; project('flaskey_todo')\"`\n\nor create a file and paste the below codes which is equivalent of the above, and then run the file\n\n```python\nfrom flaskey import project\n\nproject(\"flaskey_todo\")\n```\n\nthe command/code will create a project called `flaskey_todo` now cd into the `flaskey_todo` directory.\n\n## Create flask project app\nFor you to start an app within your project (`flaskey_todo`), run the following command\n\n`python3 thunder.py create_app -a todo_app`\n\nthis will create an app within your project (`flaskey_todo`), the `-a` flag is for the app name in this example it is called `todo_app`\n\n## Run flask server\nonce the app is created open the `thunder.py` file of your project and import your app `views.py` file\n\n`from todo_app.views import todo_app`\n\nafter that, register it to the blueprint template by\n\n`app.register_blueprint(todo_app)`\n\nonce you register the app, boot up the flask webser by\n\n`python thunder.py boot`\n\nThis will bring the flask development server on port `5000` you can give it a different port by including a `-p` flag which is for port number:\n\n`python thunder.py boot -p 7000`\n\nthis will bring the serve on port `7000` visit the localhost url with the port number, it will show you your project `index.html page` (flaskey_todo). To get to your app page (todo_app), visit the url with your app name e.g\n\n`http://127.0.0.1:7000/todo_app`\n\nthis will take you to your app `index.html page` (todo_app). From there you are ready to go.\n\n# Disclaimer\nThis software will not be compatible with `windows operating system` use other `OS` such as `linux` or `macOS`\n\n## Github repository:\n\n- https://github.com/usmanmusa1920/flaskey\n\nPull requests are welcome\n\n\nChange Log\n==========\n\n0.0.1 (29/december/2022)\n------------------\n- First Release\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "An extension of flask web framework of python that erase the complexity of constructing flask project blueprint, packages, and other annoying stuffs",
    "version": "0.0.1",
    "split_keywords": [
        "flaskey"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "abd1a7c6c0184c1c75fdfb5feaf70655",
                "sha256": "d6e943d398225f4cae9db4a2192ef0b4aa6c9785699086867647c659f4c1e97b"
            },
            "downloads": -1,
            "filename": "flaskey-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "abd1a7c6c0184c1c75fdfb5feaf70655",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9527,
            "upload_time": "2022-12-29T14:25:28",
            "upload_time_iso_8601": "2022-12-29T14:25:28.839426Z",
            "url": "https://files.pythonhosted.org/packages/e6/7e/4bd1afffe99d12b037e820644af040153d112318c3886ff1fd3118e9f1b4/flaskey-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-29 14:25:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "usmanmusa1920",
    "github_project": "flaskey",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "flaskey"
}
Usman Musa
Elapsed time: 0.02516s