Skip to content
Browse files

Rename the project from Flask-Static to Frozen-Flask.

  • Loading branch information...
1 parent 4db9c78 commit 1cfeaa73301d28c5a617c91fc6b97114a7da6ac8 @SimonSapin committed
View
6 README
@@ -1,7 +1,7 @@
-Flask-Static
+Frozen-Flask
------------
-Generates a static website from a Flask application. The result can be hosted
+Freezes a Flask application into a set of static files. The result can be hosted
without any server-side software other than a traditional web server.
-See documentation: http://packages.python.org/Flask-Static
+See documentation: http://packages.python.org/Frozen-Flask
View
4 docs/conf.py
@@ -42,7 +42,7 @@
master_doc = 'index'
# General information about the project.
-project = u'Flask-Static'
+project = u'Frozen-Flask'
copyright = u'2010, Simon Sapin'
# The version info for the project you're documenting, acts as replacement for
@@ -101,7 +101,7 @@
#html_theme_options = {}
html_theme_options = {
'index_logo': None,
- 'github_fork': 'SimonSapin/Flask-Static'
+ 'github_fork': 'SimonSapin/Frozen-Flask'
}
# Add any paths that contain custom themes here, relative to this directory.
View
24 docs/index.rst
@@ -1,9 +1,9 @@
-Flask-Static
+Frozen-Flask
============
-Flask-Static builds a static snapshot of your `Flask`_ application. The
-result can be hosted without any server-side software other than a traditional
-web server.
+Frozen-Flask freezes a `Flask`_ application into a set of static files.
+The result can be hosted without any server-side software other than a
+traditional web server.
.. _Flask: http://flask.pocoo.org/
@@ -12,14 +12,14 @@ Installation
Install the extension with one of the following commands::
- $ easy_install Flask-Static
+ $ easy_install Frozen-Flask
or alternatively if you have pip installed::
- $ pip install Flask-Static
+ $ pip install Frozen-Flask
or you can get the `source code from github
-<https://github.com/SimonSapin/Flask-Static>`_.
+<https://github.com/SimonSapin/Frozen-Flask>`_.
Configuration
-------------
@@ -28,13 +28,13 @@ To get started all you need to do is to instantiate a :class:`.StaticBuilder` ob
after configuring the application::
from flask import Flask
- from flaskext.static import StaticBuilder
+ from flaskext.frozen import StaticBuilder
app = Flask(__name__)
app.config.from_pyfile('mysettings.cfg')
builder = StaticBuilder(app)
-Flask-Static accepts the following configuration values:
+Frozen-Flask accepts the following configuration values:
``STATIC_BUILDER_DESTINATION``
Path to the directory where to put the generated static site. If relative,
@@ -97,7 +97,7 @@ here.
Filenames and MIME types
------------------------
-For each generated URL, Flask-Static simulates a request and save the content
+For each generated URL, Frozen-Flask simulates a request and save the content
in a file in the ``STATIC_BUILDER_DESTINATION`` directory. The filename is
built from the URL. URLs with a trailing slash are interpreted as a directory
name and the content is saved in ``index.html``.
@@ -116,7 +116,7 @@ For example, the following views will both fail::
return '/* ... */'
as the default ``Content-Type`` in Flask is ``text/html; charset=utf-8``, but
-the MIME types guessed by the Flask-Static as well as most web servers from the
+the MIME types guessed by the Frozen-Flask as well as most web servers from the
filenames are ``application/octet-stream`` and ``text/css``.
This can be fixed by adding a trailing slash to the URL or serving with the
@@ -135,7 +135,7 @@ right ``Content-Type``::
API
---
-.. module:: flaskext.static
+.. module:: flaskext.frozen
.. autoclass:: StaticBuilder
:members: register_generator, build, serve
View
7 flaskext/static.py → flaskext/frozen.py
@@ -1,11 +1,12 @@
"""
- flaskext.static
+ flaskext.frozen
~~~~~~~~~~~~~~~
- Flask-Static builds a static snapshot of your Flask application. The
- result can be hosted without any server-side software other than a
+ Frozen-Flask freezes a Flask application into a set of static files.
+ The result can be hosted without any server-side software other than a
traditional web server.
+
:copyright: (c) 2010 by Simon Sapin.
:license: BSD, see LICENSE for more details.
"""
View
18 setup.py
@@ -1,32 +1,32 @@
"""
-Flask-Static
+Frozen-Flask
------------
-Generates a static website from a Flask application. The result can be hosted
+Freezes a Flask application into a set of static files. The result can be hosted
without any server-side software other than a traditional web server.
Links
`````
-* `documentation <http://packages.python.org/Flask-Static>`_
+* `documentation <http://packages.python.org/Frozen-Flask>`_
* `development version
- <http://github.com/SimonSapin/Flask-Static/zipball/master#egg=Flask-Static-dev>`_
+ <http://github.com/SimonSapin/Frozen-Flask/zipball/master#egg=Frozen-Flask-dev>`_
"""
from setuptools import setup
setup(
- name='Flask-Static',
- version='0.1',
- url='https://github.com/SimonSapin/Flask-Static',
+ name='Frozen-Flask',
+ version='0.2dev',
+ url='https://github.com/SimonSapin/Frozen-Flask',
license='BSD',
author='Simon Sapin',
author_email='simon.sapin@exyr.org',
- description='Generates a static website from a Flask application',
+ description='Freezes a Flask application into a set of static files.',
long_description=__doc__,
packages=['flaskext'],
namespace_packages=['flaskext'],
- test_suite='test_flaskstatic',
+ test_suite='test_frozenflask',
zip_safe=False,
platforms='any',
install_requires=[
View
2 test_flaskstatic/__init__.py → test_frozenflask/__init__.py
@@ -6,7 +6,7 @@
import os.path
from contextlib import contextmanager
-from flaskext.static import StaticBuilder, walk_directory
+from flaskext.frozen import StaticBuilder, walk_directory
from . import test_app
View
2 test_flaskstatic/test_app/__init__.py → test_frozenflask/test_app/__init__.py
@@ -1,5 +1,5 @@
from flask import Flask, url_for
-from flaskext.static import StaticBuilder
+from flaskext.frozen import StaticBuilder
from .admin import admin_module
View
0 test_flaskstatic/test_app/admin/__init__.py → test_frozenflask/test_app/admin/__init__.py
File renamed without changes.
View
0 ...askstatic/test_app/admin/static/style.css → ...ozenflask/test_app/admin/static/style.css
File renamed without changes.
View
0 test_flaskstatic/test_app/static/style.css → test_frozenflask/test_app/static/style.css
File renamed without changes.

0 comments on commit 1cfeaa7

Please sign in to comment.
Something went wrong with that request. Please try again.