Metadata-Version: 2.0
Name: elsa
Version: 0.1
Summary: Helper module for Frozen-Flask based websites
Home-page: https://github.com/pyvec/elsa
Author: Miro Hrončok
Author-email: miro@hroncok.cz
License: MIT
Keywords: flask web github
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Dist: Flask
Requires-Dist: Frozen-Flask
Requires-Dist: click
Requires-Dist: ghp-import

elsa
====

Elsa will help you build your `Frozen-Flask <http://pythonhosted.org/Frozen-Flask/>`_ based website and deploy it to GitHub pages.
It's based on scripts from `PyLadies.cz repo <https://github.com/PyLadiesCZ/pyladies.cz>`_ and is distributed under the terms of the MIT license, see LICENSE (does not apply for the image below). It requires Python 3.

.. figure:: http://cartoonbros.com/wp-content/uploads/2015/11/Elsa-21.jpg
   :alt: Elsa

   Image linked from `cartoonbros.com <http://cartoonbros.com/elsa/>`_, not stored in the repo, so the repo remains free.

Basic usage
-----------

Create you Flask app and give it to ``elsa.cli()``:

.. code-block:: python

    from flask import Flask

    app = Flask(...)

    # do stuff with app

    if __name__ == '__main__':
        from elsa import cli
        cli(app, base_url='https://example.com')

This will add command line interface to the script, enabling you to use it like this:

.. code-block:: bash

    python foo.py serve  # serves the site, no freezing, so you can check it quickly
    python foo.py freeze  # freezes the site, i.e. makes a HTML snapshot
    python foo.py deploy  # deploys the frozen site to GitHub pages

See more options with ``--help``.

Travis CI based deployment
--------------------------

Travis CI is (in this context) a tool, that allows you to deploy the site automatically to GitHub pages after every push.
All you have to do is tell Travis to run Elsa and provide a GitHub token.
Elsa on Travis will freeze the site and deploy it frozen to GitHub pages.
Elsa knows it's being run on Travis and will use the provided GitHub token to gain push permissions.
Elsa will push force to ``gh-pages`` branch in a single commit rewriting the history and all manual changes of that branch.

Here 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):

.. code-block:: yaml

    language: python
    python:
        - '3.6'
    script:
        - 'python foo.py freeze'
    env:
      global:
        - secure: "blahblah"  # gem install travis; travis encrypt GITHUB_TOKEN=xyz --add
    deploy:
        provider: script
        script: 'python foo.py deploy --push'
        on:
            branch: master
            repo: only/yours

Testing
-------

To run the test suite, install `tox <http://tox.readthedocs.io/>`_ and run it::

    tox

Elsa uses pytest, so if you are familiar with it, feel free to run  it directly.



Further notes
-------------

URLs
~~~~

When you use URLs without trailing slash (e.g. ``https://example.com/foobar``), GitHub pages would serve the pages with bad Content-Type header
(``application/octet-stream`` instead of ``text/html``) and the browser would attempt to download it.
That's why Elsa will not allow such thing and will treat ``MimetypeMismatchWarning`` from Frozen-Flask as error.
Make 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.


Changes
=======

0.1
---

* Add a test suite
* Treat Frozen-Flask warnings as errors
* **Important:** It is now recommended to run ``freeze`` in ``.travis.yml``
  ``script`` section to catch problems in Pull Requests etc.
* **Important:**  This version of Elsa will warn if you use the ``deploy``
  command without specifying ``--push`` or ``--no-push`` explicitly.
  In a future release, it will switch to *not* pushing the built pages by
  default.
* Remove the dependency on ``sh`` to improve compatibility with Windows
* Supports Linux, Mac OS X and Windows
* The ``gh-branch`` is purged before the deploying commit (`#14`_)
* It is possible to shutdown the server via a special POST request (`#21`_)

.. _#14: https://github.com/pyvec/elsa/issues/14
.. _#21: https://github.com/pyvec/elsa/pull/21


0.1.dev4
--------

* Set template auto_reload flag directly in serve mode (`#8`_)

.. _#8: https://github.com/pyvec/elsa/issues/8


0.1.dev3
--------

* Set TEMPLATES_AUTO_RELOAD by default (`#5`_)
* Suppress a bogus warning about CNAME mime type (`#7`_)

.. _#5: https://github.com/pyvec/elsa/issues/5
.. _#7: https://github.com/pyvec/elsa/issues/7


0.1.dev2
--------

* The CNAME route is now created automatically


0.1.dev1
--------

* Initial implementation from
  `PyLadies.cz <https://github.com/PyLadiesCZ/pyladies.cz>`_


