{
"info": {
"author": "Gabi Nagy",
"author_email": "gabrian.nagy@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX",
"Operating System :: Unix",
"Programming Language :: Python",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Utilities"
],
"description": "Helpful Site\n============\n\nBeautifully simple static site generator in Python\n\nWhat's this?\n~~~~~~~~~~~~\n\nHelpful Site is a static site generator written on top of\n`Python-Markdown `_,\n`Jinja2 `_ and\n`Crammit `_. It aims to provide a\nfriendly interface for building web pages from markdown and minifying\ncss and js files. You can check out a rendering of the sample pages here\n=> http://helpfulsheep.com/toys/helpful-site/\n\nSpecifically, Helpful Site provides you with:\n\n- post categories\n- home and category pages that provide lists of posts\n- pagination for the posts on the home page\n- previous post and next post links\n- ability to mark out the excerpt using the ```` keyword\n- support for per page attributes such as description, ogimage, style\n and script\n- syntax highlighting of code blocks\n- the great looking Casper theme from `Ghost `_\n- friendly config.yaml file\n- flexible template system\n- static web server to try your site out locally\n\nHow does it work?\n~~~~~~~~~~~~~~~~~\n\nThe project provides a number of ``./manage.py`` commands that use the\nfiles from the src directory to generate a static site inside the dist\ndirectory.\n\nTo create a new page, run\n\n::\n\n ./manage.py new\n\nAfter adding content to the page, run\n\n::\n\n ./manage.py build\n\nto build the html files. If you plan to serve your site from a\nsubdirectory such as http://www.example.com/blog/, you should update the\nconfig.yaml file and run\n\n::\n\n ./manage.py build --prod\n\nTo update the css and js files, you should run\n\n::\n\n ./manage.py mini\n\nYou can also run\n\n::\n\n ./manage.py reset\n\nto remove the entire dist folder and\n\n::\n\n ./manage.py reset --all\n\nto remove the src folder as well. You can run\n\n::\n\n ./manage.py runserver\n\nto start a local server and last but not least,\n\n::\n\n ./manage.py update\n\nto both minify and build the files.\n\nGetting your hands dirty\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- cd to a comfy location\n- git clone git@github.com:g4b1nagy/helpful-site.git\n- cd helpful-site/\n- virtualenv .venv\n- source .venv/bin/activate\n- pip install -r config/requirements.txt\n- ./manage.py update\n- ./manage.py runserver\n- point your browser to\n `http://localhost:3000/ `_\n\nBuilding your site on top of this should be a matter of customizing the\nfiles in the config directory i.e. config.yaml and template files and\nadding your own css and js files to the src directory. As far as media\ngoes, there is no recommended strategy, but you could store your files\ninside each post's directory and use relative links to point to them.\nThis should provide the greatest flexibility while also keeping your\nposts atomic - limited to a single directory.\n\nKnown issues\n~~~~~~~~~~~~\n\nGoogle Chrome seems to screw up the font size from time to time when\nloading the pages. According to `this\npost `_,\nit seems to be caused by using rem units in the css files.\n\nIf you do funky stuff, such as delete the dist folder while the server\nis running, you might end up with a\n``socket.error: [Errno 98] Address already in use`` error when trying to\nrestart it. You will need to manually find the server process and\n``kill -9`` it.\n\nYes, this is written in Python 2. I am sorry. No, there are no tests. I\nam even sorrier for that.\n\nFeeling generous?\n~~~~~~~~~~~~~~~~~\n\nContributions are more than welcome and are generally rewarded with a\nhuge THANK YOU! and a [virtual] hug. Feel free to tackle any issues you\nmay have and send me a pull request afterwards.\n\nIf you have bigger plans, feel free to drop me a line at\ngabi@helpfulsheep.com.",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/g4b1nagy/helpful-site",
"keywords": null,
"license": "Unlicense",
"maintainer": null,
"maintainer_email": null,
"name": "helpful-site",
"package_url": "https://pypi.org/project/helpful-site/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/helpful-site/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/g4b1nagy/helpful-site"
},
"release_url": "https://pypi.org/project/helpful-site/0.1.0/",
"requires_dist": null,
"requires_python": null,
"summary": "Beautifully simple static site generator in Python",
"version": "0.1.0"
},
"last_serial": 1644830,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "fab209a68afb40c673a934c78e732be6",
"sha256": "9e2bb2833407159f00eadd632d7edec4ec8c5c269575e33387de1c7a543cab6f"
},
"downloads": -1,
"filename": "helpful_site-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fab209a68afb40c673a934c78e732be6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 9986,
"upload_time": "2015-07-21T12:48:44",
"url": "https://files.pythonhosted.org/packages/12/51/eaf395b6e2098894470f53d88f44872b15c820c2fa1a638e3d06445cdb4a/helpful_site-0.1.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5521c7c54fd245b96968fbea86bbca18",
"sha256": "077cd28ae65dc28773a5c97afcbdb65cc8a9b2c09542e81e975dbb52401366c0"
},
"downloads": -1,
"filename": "helpful-site-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5521c7c54fd245b96968fbea86bbca18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58744,
"upload_time": "2015-07-21T12:48:48",
"url": "https://files.pythonhosted.org/packages/7b/df/3bce68fc5d2f0d449cfaa9da56382ee2bc027e925a8b3bdc648885211ece/helpful-site-0.1.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "fab209a68afb40c673a934c78e732be6",
"sha256": "9e2bb2833407159f00eadd632d7edec4ec8c5c269575e33387de1c7a543cab6f"
},
"downloads": -1,
"filename": "helpful_site-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fab209a68afb40c673a934c78e732be6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 9986,
"upload_time": "2015-07-21T12:48:44",
"url": "https://files.pythonhosted.org/packages/12/51/eaf395b6e2098894470f53d88f44872b15c820c2fa1a638e3d06445cdb4a/helpful_site-0.1.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5521c7c54fd245b96968fbea86bbca18",
"sha256": "077cd28ae65dc28773a5c97afcbdb65cc8a9b2c09542e81e975dbb52401366c0"
},
"downloads": -1,
"filename": "helpful-site-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "5521c7c54fd245b96968fbea86bbca18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58744,
"upload_time": "2015-07-21T12:48:48",
"url": "https://files.pythonhosted.org/packages/7b/df/3bce68fc5d2f0d449cfaa9da56382ee2bc027e925a8b3bdc648885211ece/helpful-site-0.1.0.tar.gz"
}
]
}