{ "info": { "author": "sodas tsai @ Wantoto", "author_email": "sodas@wantoto.com", "bugtrack_url": null, "classifiers": [], "description": "FSS, Flask-Static-Site\n==============================================================================\nFlask-Static-Site is designed to compile **Jinja2** templates into static web\nwebpages for static hosting like Amazon AWS S3 and Github Pages.\n\nIt also provides a simple development server via **Flask microframework**.\n\n\nInstallation\n------------------------------------------------------------------------------\nJust `pip install fss`\n\n\nLayout\n------------------------------------------------------------------------------\nBy default, FSS works with files put as following layout:\n```\n*--- STATIC-SITE-ROOT // The root folder of your static site.\n |\n +--- fss_settings.py // Settings file for FSS\n |\n +--- static // Static files of this site (Default)\n | +--- index.css\n | +--- index.js\n |\n +--- templates // Jinja templates of this site (Default)\n +--- index.jinja\n +--- _temp.jinja\n +--- about\n +--- developer.jinja\n +--- designer.jinja\n```\nFSS compiles above project structure into following layout:\n```\n*--- STATIC-SITE-ROOT // The root folder of your static site.\n |\n +--- fss_settings.py // Settings file for FSS\n |\n +--- static // Static files of this site\n | +--- index.css\n | +--- index.js\n |\n +--- templates // Jinja templates of this site\n | +--- index.jinja\n | +--- _temp.jinja\n | +--- about\n | +--- developer.jinja\n | +--- designer.jinja\n |\n +--- index.html // Static html files that static-website can access\n +--- about\n +--- developer.html\n +--- designer.html\n```\nFSS finds all **Jinja2 templates** in the `templates` folder, compiles it \ninto html pages, and puts built result at root directory. *(Templates named with a prefix \"\\_\" won't be compiled)*.\n\n\nSettings (fss_settings.py)\n------------------------------------------------------------------------------\nWhen running `fss` command, `fss` finds `fss_settings.py` in current working\ndirectory. It loads the python module and update settings.\nThe default settings are:\n```python\ncwd = os.getcwd()\nstatic_folder = 'static'\ntemplates_folder = 'templates'\ntemplates_context = {}\noutput_folder = '.'\nflask_app_config = {}\n```\n\n- **static_folder**\n A folder where to find static files when running a flask dev server and compiling.\n By default, it uses `static` folder under current working directory.\n\n- **templates_folder**\n A folder where to find Jinja2 templates when running a flask dev server and compiling.\n By default, it uses `templates` folder under current working directory.\n\n- **templates_context**\n Context for rendering Jinja2 templates\n\n- **output_folder**\n A folder here to put compiled result.\n By default, it put result in the current working directory.\n\n- **flask_app_config**\n An extra dict used to setup Flask app.\n\n\n\nRequirements\n------------------------------------------------------------------------------\nWe use **Flask**, **Jinja2**, and **Frozen-Flask**. Check `requirements.txt`.\n\n\nCommands\n------------------------------------------------------------------------------\n* `fss dev_server`\n Start a local development server at http://localhost:5000 via Flask.\n\n* `fss build`\n Compile (render) Jinja2 templates into static html files.\n\n\nLicense\n------------------------------------------------------------------------------\nCopyright 2013 Wantoto Inc http://www.wantoto.com/\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/wantoto/flask-static-site/", "keywords": null, "license": "Apache License Version 2.0", "maintainer": null, "maintainer_email": null, "name": "fss", "package_url": "https://pypi.org/project/fss/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/fss/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://bitbucket.org/wantoto/flask-static-site/" }, "release_url": "https://pypi.org/project/fss/0.2.1/", "requires_dist": null, "requires_python": null, "summary": "Compile Flask/Jinja2 site into static html content", "version": "0.2.1" }, "last_serial": 964105, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "cdeb1fe2fcbbc96b39bb4dd1710aefa5", "sha256": "c80ca80aead863c7fbe7c37d4cdc4ce8eb57b58613f03cfe4bb2f93d2de08b94" }, "downloads": -1, "filename": "fss-0.1.0.tar.gz", "has_sig": false, "md5_digest": "cdeb1fe2fcbbc96b39bb4dd1710aefa5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3355, "upload_time": "2013-11-07T09:14:35", "url": "https://files.pythonhosted.org/packages/d3/ee/66266b61db7a15a8f9c6969578c9aa396bc8739e10312df3a40e3ab61929/fss-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "3a4951fe58aec70caf2b72488e690e2d", "sha256": "1a970c5e6a06ebe63c161d5fe7149bbccc69c3e14d62346f5f62f17f316afa57" }, "downloads": -1, "filename": "fss-0.1.1.tar.gz", "has_sig": false, "md5_digest": "3a4951fe58aec70caf2b72488e690e2d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3707, "upload_time": "2013-11-07T10:03:24", "url": "https://files.pythonhosted.org/packages/ef/51/4b789309f29fea81a5534d8fbf0e841e4af18398289a6ee3edd42051523a/fss-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "28c4396c572553abf84faeea913f43bd", "sha256": "cbce9308bb91f2dfd6dfc01f830f7cc8ce117408b954ddc6472fb25d016deffd" }, "downloads": -1, "filename": "fss-0.2.0.tar.gz", "has_sig": false, "md5_digest": "28c4396c572553abf84faeea913f43bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3753, "upload_time": "2013-11-08T07:17:38", "url": "https://files.pythonhosted.org/packages/a0/22/19855de830b24718557c26538b99fe63a38e620a2f43fddbd5d55577f90e/fss-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "400bc45437ac0d0ec9e138fc02c5f44c", "sha256": "7943e1aa25ebe3fadb13e7285d3846c478e03ec5e29689476e22917327fade95" }, "downloads": -1, "filename": "fss-0.2.1.tar.gz", "has_sig": false, "md5_digest": "400bc45437ac0d0ec9e138fc02c5f44c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3741, "upload_time": "2014-01-09T06:48:57", "url": "https://files.pythonhosted.org/packages/e0/a0/c415409be9c1292c8fa4dce0c250462fa2199e4d2c79e7895bcc8e24b61f/fss-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "400bc45437ac0d0ec9e138fc02c5f44c", "sha256": "7943e1aa25ebe3fadb13e7285d3846c478e03ec5e29689476e22917327fade95" }, "downloads": -1, "filename": "fss-0.2.1.tar.gz", "has_sig": false, "md5_digest": "400bc45437ac0d0ec9e138fc02c5f44c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3741, "upload_time": "2014-01-09T06:48:57", "url": "https://files.pythonhosted.org/packages/e0/a0/c415409be9c1292c8fa4dce0c250462fa2199e4d2c79e7895bcc8e24b61f/fss-0.2.1.tar.gz" } ] }