| Name | django-freeze JSON |
| Version |
0.11.0
JSON |
| download |
| home_page | |
| Summary | convert your dynamic django site to a static one with one line of code. |
| upload_time | 2024-03-04 22:14:18 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | The MIT License (MIT) Copyright (c) 2016-present Fabio Caccamo - fabio.caccamo@gmail.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
freeze
static
site
generator
generate
convert
export
download
zip
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://www.python.org/)
[](https://www.djangoproject.com/)
[](https://pypi.org/project/django-freeze/)
[](https://pepy.tech/project/django-freeze)
[](https://github.com/fabiocaccamo/django-freeze/stargazers)
[](https://github.com/fabiocaccamo/django-freeze/blob/main/LICENSE.txt)
[](https://results.pre-commit.ci/latest/github/fabiocaccamo/django-freeze/main)
[](https://github.com/fabiocaccamo/django-freeze)
[](https://codecov.io/gh/fabiocaccamo/django-freeze)
[](https://www.codacy.com/app/fabiocaccamo/django-freeze)
[](https://codeclimate.com/github/fabiocaccamo/django-freeze/)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
# django-freeze
django-freeze generates the static version of your django site.
Just run `python manage.py generate_static_site` :)
## Features
- **Generate** the **static version** of your Django site, optionally compressed **.zip file**
- **Generate/download** the static site using **urls** *(only superuser and staff)*
- Follow **sitemap.xml** urls
- Follow **internal links** founded in each page
- Follow **redirects**
- **Report** invalid/broken urls
- Selectively **include/exclude media and static files**
- Custom **base url** *(very useful if the static site will run in a specific folder different by the document-root)*
- Convert urls to **relative urls** *(very useful if the static site will run offline or in an unknown folder different by the document-root)*
- Prevent local directory index
## Installation
- Run `pip install django-freeze`
- Add `freeze` to `settings.INSTALLED_APPS`
- Enable the `sites` framework (instructions [here](https://docs.djangoproject.com/en/4.1/ref/contrib/sites/#enabling-the-sites-framework))
- Restart your application server
## Configuration (optional)
All these settings are optional, if not defined in `settings.py` the default values (listed below) will be used.
```python
#the absolute path where to store the .zip and the html files
#default value is a folder named 'freeze' located as sibling of 'settings.MEDIA_ROOT'
FREEZE_ROOT = '/...'
#tells 'freeze' if the urls should be fetched using https instead of http protocol (only if FREEZE_SITE_URL is not defined)
FREEZE_USE_HTTPS = False
#the site-url to crawl, if not specified it will be autodetected using the sites app
FREEZE_SITE_URL = 'http://mydomain.com'
#the base-url for all links relative to root '/'
#useful if the generated static site will run in a specific folder which is not the document-root
FREEZE_BASE_URL = None
#if True 'freeze' will convert all absolute urls to relative urls
#useful if the generated static site will run locally (file://) or in an unknown folder which is not the document-root (only if FREEZE_BASE_URL is not defined)
FREEZE_RELATIVE_URLS = False
#if True 'freeze' will inject a script at the end of each page
#which will force hrefs like 'path/' to 'path/index.html' (only if the site is running under file://)
#useful if the generated static site will run locally (requires FREEZE_RELATIVE_URLS set to True) to prevent local directory index
FREEZE_LOCAL_URLS = False
#if True 'freeze' will fetch each url founded in sitemap.xml
FREEZE_FOLLOW_SITEMAP_URLS = True
#if True 'freeze' will follow and fetch recursively each link-url founded in each page
FREEZE_FOLLOW_HTML_URLS = True
#if true 'freeze' will send an email to managers containing the list of all invalid urls (404, 500, etc..)
FREEZE_REPORT_INVALID_URLS = False
#the invalid urls email report subject
FREEZE_REPORT_INVALID_URLS_SUBJECT = '[freeze] invalid urls'
#if True the generated site will contain also the MEDIA folder and ALL its content
FREEZE_INCLUDE_MEDIA = True
#elif the value is a list or tuple only the specified directories will be included
FREEZE_INCLUDE_MEDIA = ('cache', 'images', 'videos', )
#if True the generated site will contain also the STATIC folder and ALL its content
FREEZE_INCLUDE_STATIC = True
#elif the value is a list or tuple only the specified directories will be included
FREEZE_INCLUDE_STATIC = ('myapp1', 'myapp2', 'myapp3', )
#if True the generated site will be zipped, the *.zip file will be created in FREEZE_ROOT
FREEZE_ZIP_ALL = False
#the name of the zip file created
FREEZE_ZIP_NAME = 'freeze'
#The request headers to use during the get requests that scrape the site
#can be used to set Authentication headers, by default sets the user-agent
FREEZE_REQUEST_HEADERS = {'user-agent': 'django-freeze'}
```
Add **freeze.urls** to `urls.py` if you want superusers and staff able to use freeze urls.
```python
urlpatterns = patterns('',
...
url(r'^freeze/', include('freeze.urls')),
...
)
```
## Usage
#### Terminal
Run `python manage.py generate_static_site`
#### URLs
Superusers and staff can use the following urls to **download a .zip** containing the generated static site or to just generate the static website.
`/freeze/download-static-site/`
`/freeze/generate-static-site/`
*(the time necessary to generate the static site depends on the size of the project)*
## TODO
- Write tests
- Add `sitemap.xml` and `robots.txt` to the generated static site
## Testing
```bash
# clone repository
git clone https://github.com/fabiocaccamo/django-extra-settings.git && cd django-extra-settings
# create virtualenv and activate it
python -m venv venv && . venv/bin/activate
# upgrade pip
python -m pip install --upgrade pip
# install requirements
pip install -r requirements.txt -r requirements-test.txt
# install pre-commit to run formatters and linters
pre-commit install --install-hooks
# run tests
tox
# or
python runtests.py
# or
python -m django test --settings "tests.settings"
```
## License
Released under [MIT License](LICENSE.txt).
---
## Supporting
- :star: Star this project on [GitHub](https://github.com/fabiocaccamo/django-extra-settings)
- :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)
- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)
- :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)
## See also
- [`django-admin-interface`](https://github.com/fabiocaccamo/django-admin-interface) - the default admin interface made customizable by the admin itself. popup windows replaced by modals. 🧙 ⚡
- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨
- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. ⚙️
- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. 🚧 🛠️
- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. ↪️
- [`django-treenode`](https://github.com/fabiocaccamo/django-treenode) - probably the best abstract model / admin for your tree based stuff. 🌳
- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘
- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳
- [`python-fontbro`](https://github.com/fabiocaccamo/python-fontbro) - friendly font operations. 🧢
- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. 🧟♂️
Raw data
{
"_id": null,
"home_page": "",
"name": "django-freeze",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "Fabio Caccamo <fabio.caccamo@gmail.com>",
"keywords": "django,freeze,static,site,generator,generate,convert,export,download,zip",
"author": "",
"author_email": "Fabio Caccamo <fabio.caccamo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/af/f8/e97e4f94f403bbc5d33306dec0c77a2a5365ba4835d0c1ca82eba7aa0c06/django-freeze-0.11.0.tar.gz",
"platform": null,
"description": "[](https://www.python.org/)\n[](https://www.djangoproject.com/)\n\n[](https://pypi.org/project/django-freeze/)\n[](https://pepy.tech/project/django-freeze)\n[](https://github.com/fabiocaccamo/django-freeze/stargazers)\n[](https://github.com/fabiocaccamo/django-freeze/blob/main/LICENSE.txt)\n\n[](https://results.pre-commit.ci/latest/github/fabiocaccamo/django-freeze/main)\n[](https://github.com/fabiocaccamo/django-freeze)\n[](https://codecov.io/gh/fabiocaccamo/django-freeze)\n[](https://www.codacy.com/app/fabiocaccamo/django-freeze)\n[](https://codeclimate.com/github/fabiocaccamo/django-freeze/)\n[](https://github.com/psf/black)\n[](https://github.com/astral-sh/ruff)\n\n# django-freeze\ndjango-freeze generates the static version of your django site.\n\nJust run `python manage.py generate_static_site` :)\n\n## Features\n\n- **Generate** the **static version** of your Django site, optionally compressed **.zip file**\n- **Generate/download** the static site using **urls** *(only superuser and staff)*\n- Follow **sitemap.xml** urls\n- Follow **internal links** founded in each page\n- Follow **redirects**\n- **Report** invalid/broken urls\n- Selectively **include/exclude media and static files**\n- Custom **base url** *(very useful if the static site will run in a specific folder different by the document-root)*\n- Convert urls to **relative urls** *(very useful if the static site will run offline or in an unknown folder different by the document-root)*\n- Prevent local directory index\n\n## Installation\n\n- Run `pip install django-freeze`\n- Add `freeze` to `settings.INSTALLED_APPS`\n- Enable the `sites` framework (instructions [here](https://docs.djangoproject.com/en/4.1/ref/contrib/sites/#enabling-the-sites-framework))\n- Restart your application server\n\n## Configuration (optional)\n\nAll these settings are optional, if not defined in `settings.py` the default values (listed below) will be used.\n\n```python\n\n#the absolute path where to store the .zip and the html files\n#default value is a folder named 'freeze' located as sibling of 'settings.MEDIA_ROOT'\nFREEZE_ROOT = '/...'\n\n#tells 'freeze' if the urls should be fetched using https instead of http protocol (only if FREEZE_SITE_URL is not defined)\nFREEZE_USE_HTTPS = False\n\n#the site-url to crawl, if not specified it will be autodetected using the sites app\nFREEZE_SITE_URL = 'http://mydomain.com'\n\n#the base-url for all links relative to root '/'\n#useful if the generated static site will run in a specific folder which is not the document-root\nFREEZE_BASE_URL = None\n\n#if True 'freeze' will convert all absolute urls to relative urls\n#useful if the generated static site will run locally (file://) or in an unknown folder which is not the document-root (only if FREEZE_BASE_URL is not defined)\nFREEZE_RELATIVE_URLS = False\n\n#if True 'freeze' will inject a script at the end of each page\n#which will force hrefs like 'path/' to 'path/index.html' (only if the site is running under file://)\n#useful if the generated static site will run locally (requires FREEZE_RELATIVE_URLS set to True) to prevent local directory index\nFREEZE_LOCAL_URLS = False\n\n#if True 'freeze' will fetch each url founded in sitemap.xml\nFREEZE_FOLLOW_SITEMAP_URLS = True\n\n#if True 'freeze' will follow and fetch recursively each link-url founded in each page\nFREEZE_FOLLOW_HTML_URLS = True\n\n#if true 'freeze' will send an email to managers containing the list of all invalid urls (404, 500, etc..)\nFREEZE_REPORT_INVALID_URLS = False\n\n#the invalid urls email report subject\nFREEZE_REPORT_INVALID_URLS_SUBJECT = '[freeze] invalid urls'\n\n#if True the generated site will contain also the MEDIA folder and ALL its content\nFREEZE_INCLUDE_MEDIA = True\n#elif the value is a list or tuple only the specified directories will be included\nFREEZE_INCLUDE_MEDIA = ('cache', 'images', 'videos', )\n\n#if True the generated site will contain also the STATIC folder and ALL its content\nFREEZE_INCLUDE_STATIC = True\n#elif the value is a list or tuple only the specified directories will be included\nFREEZE_INCLUDE_STATIC = ('myapp1', 'myapp2', 'myapp3', )\n\n#if True the generated site will be zipped, the *.zip file will be created in FREEZE_ROOT\nFREEZE_ZIP_ALL = False\n\n#the name of the zip file created\nFREEZE_ZIP_NAME = 'freeze'\n\n#The request headers to use during the get requests that scrape the site\n#can be used to set Authentication headers, by default sets the user-agent\nFREEZE_REQUEST_HEADERS = {'user-agent': 'django-freeze'}\n```\n\nAdd **freeze.urls** to `urls.py` if you want superusers and staff able to use freeze urls.\n\n```python\nurlpatterns = patterns('',\n ...\n url(r'^freeze/', include('freeze.urls')),\n ...\n)\n```\n\n## Usage\n\n#### Terminal\n\nRun `python manage.py generate_static_site`\n\n#### URLs\nSuperusers and staff can use the following urls to **download a .zip** containing the generated static site or to just generate the static website.\n\n`/freeze/download-static-site/`\n\n`/freeze/generate-static-site/`\n\n*(the time necessary to generate the static site depends on the size of the project)*\n\n## TODO\n- Write tests\n- Add `sitemap.xml` and `robots.txt` to the generated static site\n\n## Testing\n```bash\n# clone repository\ngit clone https://github.com/fabiocaccamo/django-extra-settings.git && cd django-extra-settings\n\n# create virtualenv and activate it\npython -m venv venv && . venv/bin/activate\n\n# upgrade pip\npython -m pip install --upgrade pip\n\n# install requirements\npip install -r requirements.txt -r requirements-test.txt\n\n# install pre-commit to run formatters and linters\npre-commit install --install-hooks\n\n# run tests\ntox\n# or\npython runtests.py\n# or\npython -m django test --settings \"tests.settings\"\n```\n\n## License\nReleased under [MIT License](LICENSE.txt).\n\n---\n\n## Supporting\n\n- :star: Star this project on [GitHub](https://github.com/fabiocaccamo/django-extra-settings)\n- :octocat: Follow me on [GitHub](https://github.com/fabiocaccamo)\n- :blue_heart: Follow me on [Twitter](https://twitter.com/fabiocaccamo)\n- :moneybag: Sponsor me on [Github](https://github.com/sponsors/fabiocaccamo)\n\n## See also\n\n- [`django-admin-interface`](https://github.com/fabiocaccamo/django-admin-interface) - the default admin interface made customizable by the admin itself. popup windows replaced by modals. \ud83e\uddd9 \u26a1\n\n- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. \ud83c\udfa8\n\n- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. \u2699\ufe0f\n\n- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. \ud83d\udea7 \ud83d\udee0\ufe0f\n\n- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. \u21aa\ufe0f\n\n- [`django-treenode`](https://github.com/fabiocaccamo/django-treenode) - probably the best abstract model / admin for your tree based stuff. \ud83c\udf33\n\n- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. \ud83d\udcd8\n\n- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. \ud83c\uddee\ud83c\uddf9 \ud83d\udcb3\n\n- [`python-fontbro`](https://github.com/fabiocaccamo/python-fontbro) - friendly font operations. \ud83e\udde2\n\n- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. \ud83e\udddf\u200d\u2642\ufe0f\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2016-present Fabio Caccamo - fabio.caccamo@gmail.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "convert your dynamic django site to a static one with one line of code.",
"version": "0.11.0",
"project_urls": {
"Documentation": "https://github.com/fabiocaccamo/django-freeze#readme",
"Download": "https://github.com/fabiocaccamo/django-freeze/releases",
"Funding": "https://github.com/sponsors/fabiocaccamo/",
"Homepage": "https://github.com/fabiocaccamo/django-freeze",
"Issues": "https://github.com/fabiocaccamo/django-freeze/issues",
"Twitter": "https://twitter.com/fabiocaccamo"
},
"split_keywords": [
"django",
"freeze",
"static",
"site",
"generator",
"generate",
"convert",
"export",
"download",
"zip"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c82745387633611f4b644ea206fcc9c68552f9153466d67ac08de54adc0d3aad",
"md5": "1b54f6142b5d2f23224274b39f3f34c1",
"sha256": "a752a99a968f46f800611f35bdf221f71899c5b06eca53881cf29124246c4363"
},
"downloads": -1,
"filename": "django_freeze-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b54f6142b5d2f23224274b39f3f34c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16343,
"upload_time": "2024-03-04T22:14:17",
"upload_time_iso_8601": "2024-03-04T22:14:17.095486Z",
"url": "https://files.pythonhosted.org/packages/c8/27/45387633611f4b644ea206fcc9c68552f9153466d67ac08de54adc0d3aad/django_freeze-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aff8e97e4f94f403bbc5d33306dec0c77a2a5365ba4835d0c1ca82eba7aa0c06",
"md5": "85f13186da1a7fa36e223bfd9501e19a",
"sha256": "768c67133c5b5196deaea74d100945a06cf3ac6a835b472fe96d95f461b76637"
},
"downloads": -1,
"filename": "django-freeze-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "85f13186da1a7fa36e223bfd9501e19a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14729,
"upload_time": "2024-03-04T22:14:18",
"upload_time_iso_8601": "2024-03-04T22:14:18.887984Z",
"url": "https://files.pythonhosted.org/packages/af/f8/e97e4f94f403bbc5d33306dec0c77a2a5365ba4835d0c1ca82eba7aa0c06/django-freeze-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 22:14:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fabiocaccamo",
"github_project": "django-freeze#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "django-freeze"
}
