{
    "info": {
        "author": "Longniao",
        "author_email": "longniao@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "flask-base\n==========\n\n|python3.x| |python2.x|\n\n.. figure:: https://raw.githubusercontent.com/longniao/flask-base/master/readme_media/logo.png\n   :alt: flask-base\n\n   flask-base\n\nA Flask application template with the boilerplate code already done for you.\n\n**Documentation available at http://hack4impact.github.io/flask-base.**\n\nWhat's included?\n----------------\n\n-  Blueprints\n-  User and permissions management\n-  Flask-SQLAlchemy for databases\n-  Flask-WTF for forms\n-  Flask-Assets for asset management and SCSS compilation\n-  Flask-Mail for sending emails\n-  gzip compression\n-  Redis Queue for handling asynchronous tasks\n-  ZXCVBN password strength checker\n-  CKEditor for editing pages\n\nDemos\n-----\n\nHome Page:\n\n.. figure:: https://raw.githubusercontent.com/longniao/flask-base/master/readme_media/home.gif\n   :alt: home\n\n\nRegistering User:\n\n.. figure:: https://raw.githubusercontent.com/longniao/flask-base/master/readme_media/register.gif\n   :alt: register\n\n\nAdmin Editing Page:\n\n.. figure:: https://raw.githubusercontent.com/longniao/flask-base/master/readme_media/editpage.gif\n   :alt: editpage\n\n\nAdmin Editing Users:\n\n.. figure:: https://raw.githubusercontent.com/longniao/flask-base/master/readme_media/edituser.gif\n   :alt: edituser\n\n\nSetting up\n----------\n\nClone the repo\n''''''''''''''\n\n::\n\n    $ git clone https://github.com/longniao/flask-base.git\n    $ cd flask-base\n\nInitialize a virtualenv\n'''''''''''''''''''''''\n\n::\n\n    $ pip install virtualenv\n    $ virtualenv -p /path/to/python3.x/installation env\n    $ source env/bin/activate\n\nFor mac users it will most likely be\n\n::\n\n    $ pip install virtualenv\n    $ virtualenv -p python3 env\n    $ source env/bin/activate\n\nNote: if you are using a python2.x version, point the -p value towards\nyour python2.x path\n\n(If you're on a mac) Make sure xcode tools are installed\n''''''''''''''''''''''''''''''''''''''''''''''''''''''''\n\n::\n\n    $ xcode-select --install\n\nAdd Environment Variables\n'''''''''''''''''''''''''\n\nCreate a file called ``config.env`` that contains environment variables\nin the following syntax: ``ENVIRONMENT_VARIABLE=value``. You may also\nwrap values in double quotes like\n``ENVIRONMENT_VARIABLE=\"value with spaces\"``. For example, the mailing\nenvironment variables can be set as the following. We recommend using\nSendgrid for a mailing SMTP server, but anything else will work as well.\n\n::\n\n    MAIL_USERNAME=SendgridUsername\n    MAIL_PASSWORD=SendgridPassword\n    SECRET_KEY=SuperRandomStringToBeUsedForEncryption\n\nOther Key value pairs:\n\n-  ``ADMIN_EMAIL``: set to the default email for your first admin\n   account (default is ``flask-base-admin@example.com``)\n-  ``ADMIN_PASSWORD``: set to the default password for your first admin\n   account (default is ``password``)\n-  ``DATABASE_URL``: set to a postgresql database url (default is\n   ``data-dev.sqlite``)\n-  ``REDISTOGO_URL``: set to Redis To Go URL or any redis server url\n   (default is ``http://localhost:6379``)\n-  ``RAYGUN_APIKEY``: api key for raygun (default is ``None``)\n-  ``FLASK_CONFIG``: can be ``development``, ``production``,\n   ``default``, ``heroku``, ``unix``, or ``testing``. Most of the time\n   you will use ``development`` or ``production``.\n\n**Note: do not include the ``config.env`` file in any commits. This\nshould remain private.**\n\nInstall the dependencies\n''''''''''''''''''''''''\n\n::\n\n    $ pip install -r requirements.txt\n\nOther dependencies for running locally\n''''''''''''''''''''''''''''''''''''''\n\nYou need `Redis <http://redis.io/>`__, and\n`Sass <http://sass-lang.com/>`__. Chances are, these commands will work:\n\n**Sass:**\n\n::\n\n    $ gem install sass\n\n**Redis:**\n\n*Mac (using `homebrew <http://brew.sh/>`__):*\n\n::\n\n    $ brew install redis\n\n*Linux:*\n\n::\n\n    $ sudo apt-get install redis-server\n\nYou will also need to install **PostgresQL**\n\n*Mac (using homebrew):*\n\n::\n\n    brew install postgresql\n\n*Linux (based on this\n`issue <https://github.com/hack4impact/flask-base/issues/96>`__):*\n\n::\n\n    sudo apt-get install libpq-dev\n\nCreate the database\n'''''''''''''''''''\n\n::\n\n    $ python manage.py recreate_db\n\nOther setup (e.g. creating roles in database)\n'''''''''''''''''''''''''''''''''''''''''''''\n\n::\n\n    $ python manage.py setup_dev\n\nNote that this will create an admin user with email and password\nspecified by the ``ADMIN_EMAIL`` and ``ADMIN_PASSWORD`` config\nvariables. If not specified, they are both\n``flask-base-admin@example.com`` and ``password`` respectively.\n\n[Optional] Add fake data to the database\n''''''''''''''''''''''''''''''''''''''''\n\n::\n\n    $ python manage.py add_fake_data\n\nRunning the app\n---------------\n\n::\n\n    $ source env/bin/activate\n    $ honcho start -f Local\n\nFor Windows users having issues with binding to a redis port locally,\nrefer to `this\nissue <https://github.com/hack4impact/flask-base/issues/132>`__.\n\nFormatting code\n---------------\n\nBefore you submit changes to flask-base, you may want to autoformat your\ncode with ``python manage.py format``.\n\nContributing\n------------\n\nContributions are welcome! Check out our `Waffle\nboard <https://waffle.io/hack4impact/flask-base>`__ which automatically\nsyncs with this project's GitHub issues. Please refer to our `Code of\nConduct <./CONDUCT.md>`__ for more information.\n\nDocumentation Changes\n---------------------\n\nTo make changes to the documentation refer to the `Mkdocs\ndocumentation <http://www.mkdocs.org/#installation>`__ for setup.\n\nTo create a new documentation page, add a file to the ``docs/``\ndirectory and edit ``mkdocs.yml`` to reference the file.\n\nWhen the new files are merged into ``master`` and pushed to github. Run\n``mkdocs gh-deploy`` to update the online documentation.\n\nRelated\n-------\n\nhttps://medium.freecodecamp.com/how-we-got-a-2-year-old-repo-trending-on-github-in-just-48-hours-12151039d78b#.se9jwnfk5\n\nLicense\n-------\n\n`MIT License <LICENSE.md>`__\n\n.. |Circle CI| image:: https://circleci.com/gh/hack4impact/flask-base.svg?style=svg\n   :target: https://circleci.com/gh/hack4impact/flask-base\n.. |Stories in Ready| image:: https://badge.waffle.io/hack4impact/flask-base.png?label=ready&title=Ready\n   :target: https://waffle.io/hack4impact/flask-base\n.. |Code Climate| image:: https://codeclimate.com/github/hack4impact/flask-base/badges/gpa.svg\n   :target: https://codeclimate.com/github/hack4impact/flask-base/coverage\n.. |Issue Count| image:: https://codeclimate.com/github/hack4impact/flask-base/badges/issue_count.svg\n   :target: https://codeclimate.com/github/hack4impact/flask-base\n.. |python3.x| image:: https://img.shields.io/badge/python-3.x-brightgreen.svg\n.. |python2.x| image:: https://img.shields.io/badge/python-2.x-yellow.svg\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/longniao/flask-base",
        "keywords": "flask-base flask",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "flask-base",
        "package_url": "https://pypi.org/project/flask-base/",
        "platform": "any",
        "project_url": "https://pypi.org/project/flask-base/",
        "project_urls": {
            "Homepage": "https://github.com/longniao/flask-base"
        },
        "release_url": "https://pypi.org/project/flask-base/0.0.3/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A simple Flask boilerplate app with SQLAlchemy, Redis, User Authentication, and more.",
        "version": "0.0.3"
    },
    "last_serial": 5498908,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "407bd918c8de4a8aaf96d74028cb1ed6",
                    "sha256": "f7b3a90963e1aaf61c9c69f2b5dcd17ecc3ebe4d5bef46fb667ad42fb5626fd4"
                },
                "downloads": -1,
                "filename": "flask-base-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "407bd918c8de4a8aaf96d74028cb1ed6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12442,
                "upload_time": "2019-07-08T03:26:52",
                "url": "https://files.pythonhosted.org/packages/f5/26/acf2550ec7a8fa589b137e1e19fd320427c5f5b8683aa50a1f5621e8a3ff/flask-base-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3b6789332fe2b2d056ed3945df42ddf3",
                    "sha256": "9775cebf4fd3cec011bcd364b670285a2b38f850797ee43fde861c4ddf43c06d"
                },
                "downloads": -1,
                "filename": "flask-base-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "3b6789332fe2b2d056ed3945df42ddf3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12715,
                "upload_time": "2019-07-08T04:07:14",
                "url": "https://files.pythonhosted.org/packages/fd/b1/72086c9b4844504a7ce3be01894b512e42cefba3e4d81fcae02cb2172509/flask-base-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ee61580e59bdf0f4ae908d20763fc242",
                    "sha256": "1ef4602d99c996c65c1991476f436010ed866d27284146e3a3975b72df1e499d"
                },
                "downloads": -1,
                "filename": "flask-base-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "ee61580e59bdf0f4ae908d20763fc242",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12708,
                "upload_time": "2019-07-08T04:11:40",
                "url": "https://files.pythonhosted.org/packages/f3/ec/145691f16e0bb75732309d2a18022859bde050ddafecc181f35807e7dde2/flask-base-0.0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ee61580e59bdf0f4ae908d20763fc242",
                "sha256": "1ef4602d99c996c65c1991476f436010ed866d27284146e3a3975b72df1e499d"
            },
            "downloads": -1,
            "filename": "flask-base-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "ee61580e59bdf0f4ae908d20763fc242",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12708,
            "upload_time": "2019-07-08T04:11:40",
            "url": "https://files.pythonhosted.org/packages/f3/ec/145691f16e0bb75732309d2a18022859bde050ddafecc181f35807e7dde2/flask-base-0.0.3.tar.gz"
        }
    ]
}