{
    "info": {
        "author": "Osman Goni Nahid",
        "author_email": "nirobshitol@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Framework :: Flask",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "# Flaskipy\n\nFlaskipy CLI will help you to create a RESTFul backend backend including [PostgreSQL](https://www.postgresql.org/).\n\n## Table of Contents\n\n* [Background](#background)\n* [Install](#install)\n* [Usage](#usage)\n* [Project Run](#how-to-run-this-project)\n* [Command Help](#display-the-command-options-with-the-h-option)\n* [Project Structure](#project-structure)\n* [Endpoints](#endpoints)\n* [Features Released](#features-released)\n* [Upcoming Features](#upcoming-features)\n* [Maintainers](#maintainers)\n* [Contributes](#contributes)\n* [How to become a contributor](#how-to-become-a-contributor)\n* [License](#license)\n\n## Background\n> Will be added\n\n### Python Version\n> Minimum python version should have 3.x.x or upper\n\n## Install\n\nA step by step series of examples that tell you have to get a development env running\n\n\n### How do I get set up?\nIf you would like to used ```Virtualenv```\nInstall the virtualenv using this command(If you have not installed virtualenv yet.)\n\n```ssh\n$ [sudo] pip install virtualenv\n```\nLearn more to visit [Virtualenv](https://virtualenv.pypa.io), [User Guide](https://virtualenv.pypa.io/en/stable/userguide/)\n\n```shell\n$[sudo] pip install flaskipy\n```\n\nOR, git clone\n\n```shell\n$ git clone https://github.com/osmangoninahid/flaskipy\n\n$ cd flaskipy\n$ pip install -r requirements.txt\n$ python setup.py install\n```\n\n## Usage\nWhen you will initializing, here you will be asked a question and you have to answer\n\nExample:\n\n[?] What's your project name ?: YOUR_PROJECT_NAME\n\n```shell\n// Initialize project\n$ cd [project_name]\n\n// Project structue initialize\n$ flaskipy init\n\n// Add new module\n$ flaskipy module --name YourModuleName\n\n// OR\n$ flaskipy module\n```\n\n## How to Run this project\n\n```shell\n// Development\n$ cd [project_name]\n$ python main.py\n```\n\nIt should make a question, like\n\n* Name of the project (It will create a folder in your current working directory and the folder name will be your project name)\n\n### Display the command options with the -h option:\n\n```ssh\n$ flaskipy -help\n\nUsage: flaskipy [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n--help  Show this message and exit.\n\nCommands:\ninit    Project structure initializer :return: None\nmodule  Automatically create module :param name: str...\n```\n\n## Project Structure\n\n```bash\n\u251c\u2500\u2500 config.py\n\u251c\u2500\u2500 example\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 config.ini\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 config.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 main.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 modules\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 blogs\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 controllers\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 blogs.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 models\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 routes\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0     \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 posts\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 controllers\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 posts.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 models\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 routes\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2502\u00a0\u00a0     \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 README.md\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 tests\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 utils\n\u2502\u00a0\u00a0     \u2514\u2500\u2500 __init__.py\n\u251c\u2500\u2500 flaskipy\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 commands.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 flaskipy_templates\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 config_ini.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 config.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 controller_init.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 controller.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 db.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 main.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 model_init.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 model.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 modules_init.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 README.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 requirements.txt\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 route.txt\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u251c\u2500\u2500 main.py\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 setup.cfg\n\u251c\u2500\u2500 setup.py\n\u2514\u2500\u2500 tests\n```\n\n## Endpoints\n\n| Request                   | Response                                             |\n| ------------------------- | ---------------------------------------------------- |\n| GET base-url/posts        | This will return all example with pagination support |\n| POST base-url/posts       | This will create a new example                       |\n| GET base-url/posts/{id}   | This will return a example                           |\n| PUT base-url/posts/{id}   | This is for updating a example                       |\n| DELETE base-url/posts     | This will delete the example with identification     |\n\n### Features Released\n\n* [x] RestAPI Boilerplate\n* [x] Flaskipy CLI\n\n### Upcoming Features\n\n* [ ] JWT integration for authentication and authorization\n* [ ] DeployNow integration\n* [ ] ApiDoc generation\n* [ ] Automated deploy with guinicorn and Python-Fabric\n* [ ] Dockerize\n* [ ] and Based on feedback\n\n## Maintainers\n\n* **[Osman Goni Nahid](https://github.com/osmangoninahid)**\n* **[Porimol Chandro](https://github.com/porimol)**\n\n## Contributes\n\nSee the list of [contributors](https://github.com/osmangoninahid/flaskipy/contributors) who participated in this project.\n\n### How to become a contributor\n\nIf you want to contribute to `Flaskipy` and make it better, your help is very welcome.\nYou can make constructive, helpful bug reports, feature requests and the noblest of all contributions.\nIf like to contribute in a good way, then follow the following guidelines.\n\n#### How to make a clean pull request\n\n* Create a personal fork on Github.\n* Clone the fork on your local machine.(Your remote repo on Github is called `origin`.)\n* Add the original repository as a remote called `upstream`.\n* If you created your fork a while ago be sure to pull upstream changes into your local repository.\n* Create a new branch to work on! Branch from `dev`.\n* Implement/fix your feature, comment your code.\n* Follow `Flaskipy`'s code style, including indentation(4 spaces).\n* Write or adapt tests as needed.\n* Add or change the documentation as needed.\n* Push your branch to your fork on Github, the remote `origin`.\n* From your fork open a pull request to the `dev` branch.\n* Once the pull request is approved and merged, please pull the changes from `upstream` to your local repo and delete your extra branch(es).\n\n## License\n\n### [The MIT License](LICENSE.txt)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/osmangoninahid/flaskipy",
        "keywords": "Flask-RESTFul API",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "flaskipy",
        "package_url": "https://pypi.org/project/flaskipy/",
        "platform": "",
        "project_url": "https://pypi.org/project/flaskipy/",
        "project_urls": {
            "Homepage": "https://github.com/osmangoninahid/flaskipy"
        },
        "release_url": "https://pypi.org/project/flaskipy/0.1.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Flaskipy is a cli tool for building RESTFul API with Python-Flask",
        "version": "0.1.1"
    },
    "last_serial": 3778163,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "97b7abcca201c8b7cbe474b4e39e646a",
                    "sha256": "535731f8f3691e45fa39e5fa38991817fc97d0e386050776189c943c6972c367"
                },
                "downloads": -1,
                "filename": "flaskipy-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "97b7abcca201c8b7cbe474b4e39e646a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8831,
                "upload_time": "2018-04-18T17:24:25",
                "url": "https://files.pythonhosted.org/packages/a7/67/5d07afb59c9e399e15bfbe0ad3b2ecf059d6f414ca5364b0f6b3d236a0fd/flaskipy-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7cd298e61eaa939792f27523c4071944",
                    "sha256": "43c47ea0cb727f8e8aa63467a7f08a1a3453420b9f4f02afd004a10a1de6c433"
                },
                "downloads": -1,
                "filename": "flaskipy-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "7cd298e61eaa939792f27523c4071944",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9295,
                "upload_time": "2018-04-18T18:59:39",
                "url": "https://files.pythonhosted.org/packages/c8/6e/232ad7bbf73ca44abca5f7ae9ae52a1b5a5fe608f37736d1a49997085309/flaskipy-0.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7cd298e61eaa939792f27523c4071944",
                "sha256": "43c47ea0cb727f8e8aa63467a7f08a1a3453420b9f4f02afd004a10a1de6c433"
            },
            "downloads": -1,
            "filename": "flaskipy-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7cd298e61eaa939792f27523c4071944",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9295,
            "upload_time": "2018-04-18T18:59:39",
            "url": "https://files.pythonhosted.org/packages/c8/6e/232ad7bbf73ca44abca5f7ae9ae52a1b5a5fe608f37736d1a49997085309/flaskipy-0.1.1.tar.gz"
        }
    ]
}