Welcome to PyBlue
-----------------
A simple static site generator.
Why another one? There are `many static <https://www.staticgen.com/>`__
site generators already. I found most to be way too complicated, too
many conventions and rules: put this here or there, call it this or
that. It was too tiring to keep up.
PyBlue is different. Everything is optional, nothing is required, use
only what you need. It basically stays out of the way.
Simple things are very easy:
- No configuration required.
- Works with any existing site.
- Easy to include ``markdown``.
- Easy linking to other pages.
- Tiny codebase, pyblue is around 500 lines in a single file!
Complicated tasks are easy:
- PyBlue generates the correct links even if you move pages around.
- Use `Django
Templates <https://docs.djangoproject.com/en/1.9/ref/templates/language/>`__
and all the features that it offers.
- Easily add data into each page (title, link name, or any arbitrary
content).
And you can go all the way out if you really want to:
- Load python modules into each page.
- Exposed data: database queries, results of online requests etc.
- Run python code, access and modify data from inside of each page.
- Extend the Django templates. Add your own ``templatetags``.
Documentation
~~~~~~~~~~~~~
- The `PyBlue
Documentation <https://ialbert.github.io/pyblue-central/>`__ was
generated with PyBlue itself.
You can also browse the `help in source
format <https://github.com/ialbert/pyblue-central/tree/master/docs>`__
for examples.
Install
~~~~~~~
::
pip install pyblue --upgrade
Or download it from the `PyBlue at
PyPI <https://pypi.python.org/pypi/pyblue/>`__.
Usage
~~~~~
Launch pyblue to serve a directory
::
pyblue -r docs
View your site by visiting http:://localhost:8080
Edit your pages and make changes. Reload the page to see your edits
live. Generate static output with:
::
pyblue -r docs -o html
That's all. Told you it was simple. To see extra help on options run:
::
pyblue -h
Licensing
~~~~~~~~~
- PyBlue is being developed by Istvan Albert see
https://github.com/ialbert
- PyBlue has been inspired by
`PyGreen <https://github.com/nicolas-van/pygreen>`__ created by
Nicolas Vanhoren see https://github.com/nicolas-van
- PyBlue uses the `MIT
license <https://github.com/ialbert/pyblue/blob/master/LICENSE.txt>`__.
Raw data
{
"_id": null,
"home_page": "https://github.com/ialbert/pyblue",
"name": "pyblue",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Istvan Albert",
"author_email": "istvan.albert@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/82/ff15fc7c95f5c1660518e2f8e002004355c18adf5c7ef345739b1ecd0253/pyblue-2022.8.1.tar.gz",
"platform": null,
"description": "Welcome to PyBlue\n-----------------\n\nA simple static site generator.\n\nWhy another one? There are `many static <https://www.staticgen.com/>`__\nsite generators already. I found most to be way too complicated, too\nmany conventions and rules: put this here or there, call it this or\nthat. It was too tiring to keep up.\n\nPyBlue is different. Everything is optional, nothing is required, use\nonly what you need. It basically stays out of the way.\n\nSimple things are very easy:\n\n- No configuration required.\n- Works with any existing site.\n- Easy to include ``markdown``.\n- Easy linking to other pages.\n- Tiny codebase, pyblue is around 500 lines in a single file!\n\nComplicated tasks are easy:\n\n- PyBlue generates the correct links even if you move pages around.\n- Use `Django\n Templates <https://docs.djangoproject.com/en/1.9/ref/templates/language/>`__\n and all the features that it offers.\n- Easily add data into each page (title, link name, or any arbitrary\n content).\n\nAnd you can go all the way out if you really want to:\n\n- Load python modules into each page.\n- Exposed data: database queries, results of online requests etc.\n- Run python code, access and modify data from inside of each page.\n- Extend the Django templates. Add your own ``templatetags``.\n\nDocumentation\n~~~~~~~~~~~~~\n\n- The `PyBlue\n Documentation <https://ialbert.github.io/pyblue-central/>`__ was\n generated with PyBlue itself.\n\nYou can also browse the `help in source\nformat <https://github.com/ialbert/pyblue-central/tree/master/docs>`__\nfor examples.\n\nInstall\n~~~~~~~\n\n::\n\n pip install pyblue --upgrade\n\nOr download it from the `PyBlue at\nPyPI <https://pypi.python.org/pypi/pyblue/>`__.\n\nUsage\n~~~~~\n\nLaunch pyblue to serve a directory\n\n::\n\n pyblue -r docs\n\nView your site by visiting http:://localhost:8080\n\nEdit your pages and make changes. Reload the page to see your edits\nlive. Generate static output with:\n\n::\n\n pyblue -r docs -o html\n\nThat's all. Told you it was simple. To see extra help on options run:\n\n::\n\n pyblue -h\n\nLicensing\n~~~~~~~~~\n\n- PyBlue is being developed by Istvan Albert see\n https://github.com/ialbert\n- PyBlue has been inspired by\n `PyGreen <https://github.com/nicolas-van/pygreen>`__ created by\n Nicolas Vanhoren see https://github.com/nicolas-van\n- PyBlue uses the `MIT\n license <https://github.com/ialbert/pyblue/blob/master/LICENSE.txt>`__.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PyBlue",
"version": "2022.8.1",
"project_urls": {
"Homepage": "https://github.com/ialbert/pyblue"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ce8bc978e8d991b7af0202ada6175b49a77dd796a15c16a4d06f0179ce844c8",
"md5": "5bd13ffc19ba4922edd9be6cd3fa31ca",
"sha256": "abb00bf8ee2eedded168e2470d12a1ac486c1ae110a41491ebf92ac992d88e31"
},
"downloads": -1,
"filename": "pyblue-2022.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5bd13ffc19ba4922edd9be6cd3fa31ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36434,
"upload_time": "2023-08-02T21:57:17",
"upload_time_iso_8601": "2023-08-02T21:57:17.122702Z",
"url": "https://files.pythonhosted.org/packages/4c/e8/bc978e8d991b7af0202ada6175b49a77dd796a15c16a4d06f0179ce844c8/pyblue-2022.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e82ff15fc7c95f5c1660518e2f8e002004355c18adf5c7ef345739b1ecd0253",
"md5": "d572019ed6f9e64056df9313f71a495e",
"sha256": "d1a9b36fd7cc14e47aa652e4d4c552796844116ffdd8b7c8b839f17e636ef306"
},
"downloads": -1,
"filename": "pyblue-2022.8.1.tar.gz",
"has_sig": false,
"md5_digest": "d572019ed6f9e64056df9313f71a495e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4034090,
"upload_time": "2023-08-02T21:57:23",
"upload_time_iso_8601": "2023-08-02T21:57:23.788601Z",
"url": "https://files.pythonhosted.org/packages/1e/82/ff15fc7c95f5c1660518e2f8e002004355c18adf5c7ef345739b1ecd0253/pyblue-2022.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-02 21:57:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ialbert",
"github_project": "pyblue",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyblue"
}
JSON
