{ "info": { "author": "Miro Hron\u010dok", "author_email": "miro@hroncok.cz", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet :: WWW/HTTP" ], "description": "elsa\n====\n\nElsa will help you build your `Frozen-Flask `_ based website and deploy it to GitHub pages.\nIt's based on scripts from `PyLadies.cz repo `_ and is distributed under the terms of the MIT license, see LICENSE (does not apply for the image below). It requires Python 3.\n\n.. figure:: https://raw.githubusercontent.com/pyvec/elsa/master/logo/elsa.png\n :alt: Elsa\n\n\nBasic usage\n-----------\n\nCreate you Flask app and give it to ``elsa.cli()``:\n\n.. code-block:: python\n\n from flask import Flask\n\n app = Flask(...)\n\n # do stuff with app\n\n if __name__ == '__main__':\n from elsa import cli\n cli(app, base_url='https://example.com')\n\nThis will add command line interface to the script, enabling you to use it like this:\n\n.. code-block:: bash\n\n python foo.py serve # serves the site, no freezing, so you can check it quickly\n python foo.py freeze # freezes the site, i.e. makes a HTML snapshot\n python foo.py deploy # deploys the frozen site to GitHub pages\n\nSee more options with ``--help``.\n\nFollow the `quickstart tutorial\n`_\nfor more information.\n\nTravis CI based deployment\n--------------------------\n\nTravis CI is (in this context) a tool, that allows you to deploy the site automatically to GitHub pages after every push.\nAll you have to do is tell Travis to run Elsa and provide a GitHub token.\nElsa on Travis will freeze the site and deploy it frozen to GitHub pages.\nElsa knows it's being run on Travis and will use the provided GitHub token to gain push permissions.\nElsa will push force to ``gh-pages`` branch in a single commit rewriting the history and all manual changes of that branch.\n\nHere is an example ``.travis.yml`` file for automatic deployment. It assumes elsa and other requirements are in ``requirements.txt`` and that you are familiar with Travis CI (so it's not very verbose):\n\n.. code-block:: yaml\n\n language: python\n python:\n - '3.6'\n script:\n - 'python foo.py freeze'\n env:\n global:\n - secure: \"blahblah\" # gem install travis; travis encrypt GITHUB_TOKEN=xyz --add\n deploy:\n provider: script\n skip_cleanup: true\n script: 'python foo.py deploy --no-freeze --push'\n on:\n branch: master\n repo: only/yours\n\nTesting\n-------\n\nTo run the test suite, install `tox `_ and run it::\n\n tox\n\nElsa uses pytest, so if you are familiar with it, feel free to run it directly.\n\n\n\nFurther notes\n-------------\n\nURLs\n~~~~\n\nWhen you use URLs without trailing slash (e.g. ``https://example.com/foobar``), GitHub pages would serve the pages with bad Content-Type header\n(``application/octet-stream`` instead of ``text/html``) and the browser would attempt to download it.\nThat's why Elsa will not allow such thing and will treat ``MimetypeMismatchWarning`` from Frozen-Flask as error.\nMake sure to use URLs with trailing slash (e.g. ``https://example.com/foobar/``) instead, so Frozen-Flask will create ``index.html`` in a folder and GitHub pages will use proper content type.\n\n\nChanges\n=======\n\n0.1.5\n-----\n\n* Add ``--verbose`` option for the CLI. If used, it prints all frozen URLs\n to standard error. Useful when freezing big projects on Travis CI. (`#51`_)\n\n.. _#51: https://github.com/pyvec/elsa/pull/51\n\n0.1.4\n-----\n\n* Add ``invoke_cli`` option for the ``cli`` function.\n If set to ``False``, it only returns the cli for further extending. (`#45`_)\n* Don't remove the remote tracking branch when ``--no-push`` is used (fixes `#41`_)\n* Improve handling of ``FrozenFlaskWarning`` (`#37`_)\n* Add the ``--show-git-push-stderr`` option to make deploy more verbose,\n this can help debug problems, but is potentially dangerous, hence the output\n of ``git push`` is hidden by default. (`#37`_)\n\n.. _#37: https://github.com/pyvec/elsa/pull/37\n.. _#41: https://github.com/pyvec/elsa/issues/41\n.. _#45: https://github.com/pyvec/elsa/pull/45\n\n0.1.3\n-----\n\n* Only treat Frozen-Flask warnings as errors, not other warnings (`#34`_)\n* Add a ``--remote`` option for ``deploy`` to use a custom git remote\n* Be consistent on local vs Travis CI deployment, always erase the history\n of the ``gh-pages`` branch (actually fixes `#14`_)\n\n.. _#14: https://github.com/pyvec/elsa/issues/14\n.. _#34: https://github.com/pyvec/elsa/pull/34\n\n\n0.1.2\n-----\n\n* **Security:** Do not display the remote URL when pushing gh-pages branch.\n If you used Elsa 0.1 or 0.1.1 on Travis CI, revoke your GitHub\n token, it was probably leaked in the log. (`#25`_)\n\n.. _#25: https://github.com/pyvec/elsa/issues/25\n\n\n0.1.1\n-----\n\n* Fix a problem with Travis CI based deployment\n\n\n0.1\n---\n\n* Add a test suite\n* Treat Frozen-Flask warnings as errors\n* **Important:** It is now recommended to run ``freeze`` in ``.travis.yml``\n ``script`` section to catch problems in Pull Requests etc.\n* **Important:** This version of Elsa will warn if you use the ``deploy``\n command without specifying ``--push`` or ``--no-push`` explicitly.\n In a future release, it will switch to *not* pushing the built pages by\n default.\n* Remove the dependency on ``sh`` to improve compatibility with Windows\n* Supports Linux, Mac OS X and Windows\n* The ``gh-branch`` is purged before the deploying commit (`#14`_)\n* It is possible to shutdown the server via a special POST request (`#21`_)\n\n.. _#14: https://github.com/pyvec/elsa/issues/14\n.. _#21: https://github.com/pyvec/elsa/pull/21\n\n\n0.1.dev4\n--------\n\n* Set template auto_reload flag directly in serve mode (`#8`_)\n\n.. _#8: https://github.com/pyvec/elsa/issues/8\n\n\n0.1.dev3\n--------\n\n* Set TEMPLATES_AUTO_RELOAD by default (`#5`_)\n* Suppress a bogus warning about CNAME mime type (`#7`_)\n\n.. _#5: https://github.com/pyvec/elsa/issues/5\n.. _#7: https://github.com/pyvec/elsa/issues/7\n\n\n0.1.dev2\n--------\n\n* The CNAME route is now created automatically\n\n\n0.1.dev1\n--------\n\n* Initial implementation from\n `PyLadies.cz `_\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pyvec/elsa", "keywords": "flask web github", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "elsa", "package_url": "https://pypi.org/project/elsa/", "platform": "", "project_url": "https://pypi.org/project/elsa/", "project_urls": { "Homepage": "https://github.com/pyvec/elsa" }, "release_url": "https://pypi.org/project/elsa/0.1.5/", "requires_dist": [ "click", "Flask", "Frozen-Flask (>=0.15)", "ghp-import" ], "requires_python": "", "summary": "Helper module for Frozen-Flask based websites", "version": "0.1.5" }, "last_serial": 3942662, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "887b8e98070f55deb9487dfc1e9ef418", "sha256": "7ff3c66bc578ef901425fa200eed5a3914d41f3b5528b4b2c14e6bee6f9198e8" }, "downloads": -1, "filename": "elsa-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "887b8e98070f55deb9487dfc1e9ef418", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9640, "upload_time": "2017-02-22T12:50:16", "url": "https://files.pythonhosted.org/packages/cf/49/5af7888098daad05fcaa6faf61c3006d523cd747a63b28e1c61de5ac4b64/elsa-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "55462f3dd3827bb4f84710e53bfd8555", "sha256": "30610ab5d5c86231d092d20bac5dc7c395d48f462560725ca0cba7b0c5e77e85" }, "downloads": -1, "filename": "elsa-0.1.tar.gz", "has_sig": false, "md5_digest": "55462f3dd3827bb4f84710e53bfd8555", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10439, "upload_time": "2017-02-22T12:50:18", "url": "https://files.pythonhosted.org/packages/5a/ad/a8262768a808f0fc2e2bd3e4fed71c303cf2dc41071df4818aae9658af24/elsa-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "bb31d36c572cd15cc9267a1aa665ad28", "sha256": "cf3fd7831c57d27a685b4faa7f8f8e02e40f6db8671d56ca1c86fbfb90ed8961" }, "downloads": -1, "filename": "elsa-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bb31d36c572cd15cc9267a1aa665ad28", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9710, "upload_time": "2017-02-22T14:52:07", "url": "https://files.pythonhosted.org/packages/13/7b/7f2db59411ff39b5a1e6d9d12c3e76ab75537403bd49c65d4e8349da3572/elsa-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "23f0c3ef5ebdb4b388798ea8831335a7", "sha256": "6d71da55c6e4f207eaa8aeb5a6c2e327072b0a55a091f5feb5c6fe0951cfae14" }, "downloads": -1, "filename": "elsa-0.1.1.tar.gz", "has_sig": false, "md5_digest": "23f0c3ef5ebdb4b388798ea8831335a7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10482, "upload_time": "2017-02-22T14:52:09", "url": "https://files.pythonhosted.org/packages/3c/e2/8d13669acce2b1a874fa1eaaad510523f77739bcf6e97f53151e03a90663/elsa-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "815e0ab66ce8c00928e683db2046fd27", "sha256": "e5cd56527a5d8882b6a866627e347dfadcacf70075232773d5030c039773663f" }, "downloads": -1, "filename": "elsa-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "815e0ab66ce8c00928e683db2046fd27", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9960, "upload_time": "2017-02-23T20:08:05", "url": "https://files.pythonhosted.org/packages/65/8b/cd8f53aa51197c6f1aa02730d09a5084331a84750c008a17486895170282/elsa-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "70c62673d7eaeb93f1eeb829c3d4f56a", "sha256": "d323b00b247904149d970c73acdb1399bb99022ddc2393e6b5b0dce1aac9d416" }, "downloads": -1, "filename": "elsa-0.1.2.tar.gz", "has_sig": false, "md5_digest": "70c62673d7eaeb93f1eeb829c3d4f56a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10779, "upload_time": "2017-02-23T20:08:07", "url": "https://files.pythonhosted.org/packages/95/d8/6657d4d14eb2a3ebfefb569224f61e58bedbf08e956480a13de4e610d8d3/elsa-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "a62b68368003a74b2a690405e801fe50", "sha256": "35e48822dda8cd48ac527dbf4f8776d0a7ab50475d7e6291e63e7f31d2d4dd5c" }, "downloads": -1, "filename": "elsa-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "a62b68368003a74b2a690405e801fe50", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10552, "upload_time": "2017-04-04T09:51:30", "url": "https://files.pythonhosted.org/packages/d8/60/d1611a858e5f527c40477eecc98bae3ea36d28fa0860cd3b7597e3c91785/elsa-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fa25b814567b33b274a78f217fd4f54b", "sha256": "bc209710274e8b4b2daba0f7945ce75b628026cd2d5da7a0885f11b5c470d947" }, "downloads": -1, "filename": "elsa-0.1.3.tar.gz", "has_sig": false, "md5_digest": "fa25b814567b33b274a78f217fd4f54b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14965, "upload_time": "2017-04-04T09:51:32", "url": "https://files.pythonhosted.org/packages/2e/62/424f25fc2af8c70fe38a255b31f8b9bab6243b3c3f2c403346b02391bac6/elsa-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "87e535b2383d6f98636adda366df2aa6", "sha256": "0a9ee0967b3c48b789b8156125a723d248c48949dfe50e6087753d002efb95c3" }, "downloads": -1, "filename": "elsa-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "87e535b2383d6f98636adda366df2aa6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11571, "upload_time": "2018-03-26T19:49:11", "url": "https://files.pythonhosted.org/packages/f0/c5/f68b2b2c11faec979fc5b6c7cd017475d13efa9b10f8ebb1829ee6a2774d/elsa-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c6a0f9d7758ec991783fb9c82651d017", "sha256": "19c969838322ed91abdcb419d97dc4e43f3664e3a0855905c98edfb149003227" }, "downloads": -1, "filename": "elsa-0.1.4.tar.gz", "has_sig": false, "md5_digest": "c6a0f9d7758ec991783fb9c82651d017", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16307, "upload_time": "2018-03-26T19:49:12", "url": "https://files.pythonhosted.org/packages/a6/d7/75ac7553327112c9701018b5558c75e7152a312f786c2b5e9b8c2656a2c1/elsa-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "8b286d12308bcc55e6e2ca2bd498794d", "sha256": "7a70c216956703398cb0fc3a6b69975da4dc1fd41dc92a19944cf50fec016f75" }, "downloads": -1, "filename": "elsa-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "8b286d12308bcc55e6e2ca2bd498794d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11814, "upload_time": "2018-06-08T11:53:45", "url": "https://files.pythonhosted.org/packages/3a/5b/1d752a6915a99a3ca480b006c0039bace4724476e8591de06ff50e81b054/elsa-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "054f81d1364676fed5e071a04fdabadb", "sha256": "2fc0ebb1ad7dfa4f9930ac9e6819b836edc4223de520f87a62423cf0f489f560" }, "downloads": -1, "filename": "elsa-0.1.5.tar.gz", "has_sig": false, "md5_digest": "054f81d1364676fed5e071a04fdabadb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16553, "upload_time": "2018-06-08T11:53:47", "url": "https://files.pythonhosted.org/packages/1c/b4/114fbf63bc9768a0637238747da7d41bba9855db44992fa9ad78cb64737d/elsa-0.1.5.tar.gz" } ], "0.1.dev1": [ { "comment_text": "", "digests": { "md5": "7fbe68ce6ee1b2b7b5a3bdae4841dec3", "sha256": "d4ec4b353f57e17440ad229db2e7a7e56e6f0d39696873dc39b7da9bdbb43b3d" }, "downloads": -1, "filename": "elsa-0.1.dev1.tar.gz", "has_sig": false, "md5_digest": "7fbe68ce6ee1b2b7b5a3bdae4841dec3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4579, "upload_time": "2016-08-18T13:52:44", "url": "https://files.pythonhosted.org/packages/a7/71/f4aeccd8cf1da94be9291a47260bc9a5de526c49ea648b26ff1055088e3a/elsa-0.1.dev1.tar.gz" } ], "0.1.dev2": [ { "comment_text": "", "digests": { "md5": "fc1fb42d9669b9cb1c4c327664a2dc71", "sha256": "1149c7d05a908d9f49258ed01b2bf7092984d0ba509d09866999691aa6d862f4" }, "downloads": -1, "filename": "elsa-0.1.dev2.tar.gz", "has_sig": false, "md5_digest": "fc1fb42d9669b9cb1c4c327664a2dc71", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4639, "upload_time": "2016-08-20T09:31:43", "url": "https://files.pythonhosted.org/packages/b3/9d/1d33badf009657e8d39ef20c4a2388146f9616abdfb16bae499a3120fd3d/elsa-0.1.dev2.tar.gz" } ], "0.1.dev3": [ { "comment_text": "", "digests": { "md5": "90b006a9557bdf3306277b4537014115", "sha256": "4fe4d2898f9462a1949ca635bc6b3ce6a18fe6b881ec68c01b5fefa41f493928" }, "downloads": -1, "filename": "elsa-0.1.dev3-py3-none-any.whl", "has_sig": false, "md5_digest": "90b006a9557bdf3306277b4537014115", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7123, "upload_time": "2017-02-02T17:40:40", "url": "https://files.pythonhosted.org/packages/45/ce/f35e31fcf1b9ed0fa23933522cb11bb120ee80b05ad3a3a55805a154c7aa/elsa-0.1.dev3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "700ce29a6d37821ea61430d6679beb7d", "sha256": "4eb47c7ffe1515ed63bc1a73552706acf4acd31adecc3325aebec5e21cf4c90d" }, "downloads": -1, "filename": "elsa-0.1.dev3.tar.gz", "has_sig": false, "md5_digest": "700ce29a6d37821ea61430d6679beb7d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5350, "upload_time": "2017-02-02T17:40:43", "url": "https://files.pythonhosted.org/packages/f6/b3/6f8f32cf364d93d2b3f9dd8f330f6d6146c171294e6336881866e15f9b39/elsa-0.1.dev3.tar.gz" } ], "0.1.dev4": [ { "comment_text": "", "digests": { "md5": "57407ed24b639fa9f3302f97bc183b59", "sha256": "fa74c00d07fd9310fddbb7faacf93be0a297b7f7c9e910bbc73753b7799010ed" }, "downloads": -1, "filename": "elsa-0.1.dev4-py3-none-any.whl", "has_sig": false, "md5_digest": "57407ed24b639fa9f3302f97bc183b59", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7207, "upload_time": "2017-02-06T12:28:35", "url": "https://files.pythonhosted.org/packages/36/32/ec2e2ab201dc779ccb92a300a42297760a78268038a3cf19bc4ddfae1cdd/elsa-0.1.dev4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "71f72fe16ad165f3076e76992a362189", "sha256": "5e238e7cc56d5427c77bac635be5b08ca2a2a8cb7bf455137cab07fc93386cbd" }, "downloads": -1, "filename": "elsa-0.1.dev4.tar.gz", "has_sig": false, "md5_digest": "71f72fe16ad165f3076e76992a362189", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5397, "upload_time": "2017-02-06T12:28:37", "url": "https://files.pythonhosted.org/packages/e4/cd/e7978ba517321fcc7356d29c94cebec9c45eaf65619448d1f7da549b33cc/elsa-0.1.dev4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8b286d12308bcc55e6e2ca2bd498794d", "sha256": "7a70c216956703398cb0fc3a6b69975da4dc1fd41dc92a19944cf50fec016f75" }, "downloads": -1, "filename": "elsa-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "8b286d12308bcc55e6e2ca2bd498794d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11814, "upload_time": "2018-06-08T11:53:45", "url": "https://files.pythonhosted.org/packages/3a/5b/1d752a6915a99a3ca480b006c0039bace4724476e8591de06ff50e81b054/elsa-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "054f81d1364676fed5e071a04fdabadb", "sha256": "2fc0ebb1ad7dfa4f9930ac9e6819b836edc4223de520f87a62423cf0f489f560" }, "downloads": -1, "filename": "elsa-0.1.5.tar.gz", "has_sig": false, "md5_digest": "054f81d1364676fed5e071a04fdabadb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16553, "upload_time": "2018-06-08T11:53:47", "url": "https://files.pythonhosted.org/packages/1c/b4/114fbf63bc9768a0637238747da7d41bba9855db44992fa9ad78cb64737d/elsa-0.1.5.tar.gz" } ] }