Django Wools
============
Django tools from WITH.
That's a collection of things that we at [WITH](https://with-madrid.com/) got
tired of copy/pasting in every project.
## Install
```
pip install django_wools
```
## Included Wools
### Storage
#### `django_wools.storage.GzipManifestStaticFilesStorage`
That's a sub-class of the
[ManifestStaticFilesStorage](https://docs.djangoproject.com/en/3.0/ref/contrib/staticfiles/#manifeststaticfilesstorage)
but that makes sure that along with all the files comes a `.gz` version which
is easy to pick up for nginx (or other static files server).
### Middlewares
#### `django_wools.middlewares.NowMiddleware`
Suppose that you have a content that is available up until a given date. When
the date is passed then everything related to this content expires. However,
in order to do this, you're probably going to make several request, possibly in
loosely connected parts of your code. In those cases, when looking at the time,
the clock will show different value as the time passes between calls. It means
that you could very well end up with one half of your code considering that the
object is still valid but the other half that it expired.
In order to prevent this, the simplest is to consider that the time is fixed
and that the code executes instantly at the moment of the request. The goal
of this middleware is to save the current time at each request and then to
provide an easy way to get the current time through the request.
If the middleware is activated, you should be able to get the time like this:
```python
from time import sleep
from django.shortcuts import render
def my_view(request):
print(f"Now is {request.now()}")
sleep(42)
print(f"Now is still {request.now()}")
return render(request, "something.html", {"now": request.now()})
```
#### `django_wools.middlewares.SlowMiddleware`
When developing a SPA or hybrid app, you want to make sure that the app is
structurally ready to handle load times from the server, even if the connection
is a bit shaky. Also, you want to make sure that not too many requests are
sent.
In order for you to fully realize how slow your website is going to be on a bad
connection, th e SlowMiddleware will automatically add a delay before replying
to each request.
Add this to your `settings.py`
```python
MIDDLEWARE = [
# ...
"django_wools.middlewares.SlowMiddleware",
]
SLOW_MIDDLEWARE_LATENCY = 1 if DEBUG else 0
```
By doing this, your requests will be added a 1s delay if the `DEBUG` mode is
enabled.
### Database
#### `django_wools.db.require_lock`
Provides a way to explicitly generate a PostgreSQL lock on a table.
By example:
```python
from django.db.transaction import atomic
from django_wools.db import require_lock
from my_app.models import MyModel
@atomic
@require_lock(MyModel, 'ACCESS EXCLUSIVE')
def myview(request):
# do stuff here
```
### Wagtail Images
Several Wagtail-specific tags are provided to deal with images and more
specifically responsive images. To use it:
1. Add `django_wools` to `INSTALLED_APPS`
2. Import `wools_for_wt_images` from your template
```
{% load wools_for_wt_images %}
```
Some specific settings can be set:
- `WOOLS_MAX_PIXEL_RATIO` _(default: `3`)_ — Highest device pixel ratio
to support.
- `WOOLS_INCREMENT_STEP_PERCENT` _(default: `(sqrt(2) - 1) * 100`)_ — The
percentage of increase from the base density to the next one. The default
values will generate `x1`, `x2` and `x4` with intermediate values that are
`x1.4142` and `x2.8284`.
All the tags will be default generate WebP images with a PNG fallback. The
fallback can be changed to JPEG and the main format has to be WebP.
#### `image_fixed_size`
This tag will generate a `<picture>` tag for an image whose size in pixels you
known in advance. That picture size will be enforced in the HTML code with
inline properties.
Usage:
```
{% image_fixed_size max-500x500 %}
```
The arguments to this tag, in order, are:
- `image` — The Wagtail-compatible image itself
- `spec` — A spec like you would give to Wagtail (`fill-500x500`,
`max-500x500`, etc)
- `css_class` — CSS class that will be added to the root <picture> element.
- `fallback_format` — The format to fallback in case the browser doesn't
support WebP. Can either be `"jpeg"` or `"png"`. Defaults to `"png"`.
- `lossless` — A boolean to enable losslessness of WebP. This does not
affect the fallback format, so if you want a lossless fallback as well you'll
need to use PNG.
### Fonts
Wools offers a way to easily download and manage fonts from Google fonts or
other pluggable providers. The current version only works with Google fonts,
however you are free to create your own sources and converters that will be
able to work out what you need.
#### Getting started
The first thing would be to put the font families that you want into the
`settings.py` of your project. By example:
```python
WOOLS_FONTS_FAMILIES = [
('google', 'Roboto'),
('google', 'Nunito'),
]
```
Here we're getting Roboto and Nunito from Google Fonts.
> *Note* — Please make sure that `django_wools` is in your
> `INSTALLED_APPS` for this to work.
Now let's run the download command:
```
./manage.py wools_import_fonts
```
And finally, let's put this tag in your page's HTML:
```html
{% load wools_fonts %}
<!DOCTYPE html>
<html class="no-js" lang="{{ CURRENT_LANG }}">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{{ title }}</title>
{% fonts_head %}
</head>
</html>
```
And that's it! The fonts you asked for will be loaded automatically.
#### Configuration options
There is several settings that you can adjust.
##### `WOOLS_FONTS_DIR`
Directory name relative to the static root where the files will be stored.
> *Default*: `"fonts"`
##### `WOOLS_STATIC_ROOT`
Absolute path to the static root that you want to use to store the fonts. If
set to none, the first value from `STATICFILES_DIRS` will be used instead.
> *Default*: `None`
##### `WOOLS_FAMILIES`
Font families that you want to load. It's a list of (provider, family) tuples.
Instead of providing tuples, you can provide
`django_wools.settings_types.FontFamily` instances directly. In case you don't
provide them, the tuple will be passed as *args to the constructor of
`FontFamily`.
> *Default*: `[]`
##### `WOOLS_FONTS_PROVIDERS`
Dictionary of available font providers. The key is the name of the provider
while the value is the FQN of the class.
If you want to provide your own provider, you can specifcy any class as long as
it implements the `django_wools.fonts.WoolFontProvider` interface.
> *Default*: `{"google": "django_wools.fonts.GoogleFontsProvider"}`
##### `WOOLS_FONTS_FORMATS`
List of font formats that you want. Choices are `ttf`, `woff`, `woff2`, `eot`,
`svg`, `otf`. You can also directly provide instances of
`django_wools.settings_types.FontFormat`.
Font formats will be proposed in the same order to the browser.
> *Default*: `[FontFormat.woff2, FontFormat.ttf]`
##### `WOOLS_FONTS_CONVERSIONS`
Font sources will provide the fonts in a given format (most likely TTF) but in
order to produce the formats expected by `WOOLS_FONTS_FORMATS` you need to
convert those fonts.
This is a dictionary that as key takes a tuple of (from_format, to_format) and
as value a sequential list of converters to use.
By example, suppose that you only have "TTF to WOFF2" and "EOT to TTF" avaible
and your source is in EOT while formats are TTF and WOFF2. In that case you can
specificy that the conversion from "EOT to WOFF2" goes through TTF.
> *Default*:
```python
{
(FontFormat.ttf, FontFormat.woff): ["django_wools.fonts.TtfToWoff"],
(FontFormat.ttf, FontFormat.woff2): ["django_wools.fonts.TtfToWoff2"],
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/WithIO/django-wools",
"name": "django-wools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "R\u00e9my Sanchez",
"author_email": "remy.sanchez@with-madrid.com",
"download_url": "https://files.pythonhosted.org/packages/21/37/7d50ef5a7d2b28a286f96416d994ded4e812c0126344993c0d83a0c82cdc/django_wools-0.2.1.tar.gz",
"platform": null,
"description": "Django Wools\n============\n\nDjango tools from WITH.\n\nThat's a collection of things that we at [WITH](https://with-madrid.com/) got\ntired of copy/pasting in every project.\n\n## Install\n\n```\npip install django_wools\n```\n\n## Included Wools\n\n### Storage\n\n#### `django_wools.storage.GzipManifestStaticFilesStorage`\n\nThat's a sub-class of the \n[ManifestStaticFilesStorage](https://docs.djangoproject.com/en/3.0/ref/contrib/staticfiles/#manifeststaticfilesstorage)\nbut that makes sure that along with all the files comes a `.gz` version which\nis easy to pick up for nginx (or other static files server).\n\n### Middlewares\n\n#### `django_wools.middlewares.NowMiddleware`\n\nSuppose that you have a content that is available up until a given date. When\nthe date is passed then everything related to this content expires. However,\nin order to do this, you're probably going to make several request, possibly in\nloosely connected parts of your code. In those cases, when looking at the time,\nthe clock will show different value as the time passes between calls. It means\nthat you could very well end up with one half of your code considering that the\nobject is still valid but the other half that it expired.\n\nIn order to prevent this, the simplest is to consider that the time is fixed\nand that the code executes instantly at the moment of the request. The goal\nof this middleware is to save the current time at each request and then to\nprovide an easy way to get the current time through the request.\n\nIf the middleware is activated, you should be able to get the time like this:\n\n```python\nfrom time import sleep\nfrom django.shortcuts import render\n\ndef my_view(request):\n print(f\"Now is {request.now()}\")\n sleep(42)\n print(f\"Now is still {request.now()}\")\n\n return render(request, \"something.html\", {\"now\": request.now()})\n```\n\n#### `django_wools.middlewares.SlowMiddleware`\n\nWhen developing a SPA or hybrid app, you want to make sure that the app is\nstructurally ready to handle load times from the server, even if the connection\nis a bit shaky. Also, you want to make sure that not too many requests are\nsent.\n\nIn order for you to fully realize how slow your website is going to be on a bad\nconnection, th e SlowMiddleware will automatically add a delay before replying\nto each request.\n\nAdd this to your `settings.py`\n\n```python\nMIDDLEWARE = [\n # ...\n \"django_wools.middlewares.SlowMiddleware\",\n]\n\nSLOW_MIDDLEWARE_LATENCY = 1 if DEBUG else 0\n```\n\nBy doing this, your requests will be added a 1s delay if the `DEBUG` mode is\nenabled.\n\n### Database\n\n#### `django_wools.db.require_lock`\n\nProvides a way to explicitly generate a PostgreSQL lock on a table.\n\nBy example:\n\n```python\nfrom django.db.transaction import atomic\nfrom django_wools.db import require_lock\n\nfrom my_app.models import MyModel\n\n\n@atomic\n@require_lock(MyModel, 'ACCESS EXCLUSIVE')\ndef myview(request):\n # do stuff here\n```\n\n### Wagtail Images\n\nSeveral Wagtail-specific tags are provided to deal with images and more\nspecifically responsive images. To use it:\n\n1. Add `django_wools` to `INSTALLED_APPS`\n2. Import `wools_for_wt_images` from your template\n\n```\n{% load wools_for_wt_images %}\n```\n\nSome specific settings can be set:\n\n- `WOOLS_MAX_PIXEL_RATIO` _(default: `3`)_ — Highest device pixel ratio\n to support.\n- `WOOLS_INCREMENT_STEP_PERCENT` _(default: `(sqrt(2) - 1) * 100`)_ — The\n percentage of increase from the base density to the next one. The default\n values will generate `x1`, `x2` and `x4` with intermediate values that are\n `x1.4142` and `x2.8284`.\n\nAll the tags will be default generate WebP images with a PNG fallback. The\nfallback can be changed to JPEG and the main format has to be WebP.\n\n#### `image_fixed_size`\n\nThis tag will generate a `<picture>` tag for an image whose size in pixels you\nknown in advance. That picture size will be enforced in the HTML code with\ninline properties.\n\nUsage:\n\n```\n{% image_fixed_size max-500x500 %}\n```\n\nThe arguments to this tag, in order, are:\n\n- `image` — The Wagtail-compatible image itself\n- `spec` — A spec like you would give to Wagtail (`fill-500x500`,\n `max-500x500`, etc)\n- `css_class` — CSS class that will be added to the root <picture> element.\n- `fallback_format` — The format to fallback in case the browser doesn't\n support WebP. Can either be `\"jpeg\"` or `\"png\"`. Defaults to `\"png\"`.\n- `lossless` — A boolean to enable losslessness of WebP. This does not\n affect the fallback format, so if you want a lossless fallback as well you'll\n need to use PNG.\n\n### Fonts\n\nWools offers a way to easily download and manage fonts from Google fonts or\nother pluggable providers. The current version only works with Google fonts,\nhowever you are free to create your own sources and converters that will be\nable to work out what you need.\n\n#### Getting started\n\nThe first thing would be to put the font families that you want into the\n`settings.py` of your project. By example:\n\n```python\nWOOLS_FONTS_FAMILIES = [\n ('google', 'Roboto'),\n ('google', 'Nunito'),\n]\n```\n\nHere we're getting Roboto and Nunito from Google Fonts.\n\n> *Note* — Please make sure that `django_wools` is in your\n> `INSTALLED_APPS` for this to work.\n\nNow let's run the download command:\n\n```\n./manage.py wools_import_fonts\n```\n\nAnd finally, let's put this tag in your page's HTML:\n\n```html\n{% load wools_fonts %}\n\n<!DOCTYPE html>\n<html class=\"no-js\" lang=\"{{ CURRENT_LANG }}\">\n<head>\n <meta charset=\"utf-8\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n\n <title>{{ title }}</title>\n\n {% fonts_head %}\n</head>\n</html>\n```\n\nAnd that's it! The fonts you asked for will be loaded automatically.\n\n#### Configuration options\n\nThere is several settings that you can adjust.\n\n##### `WOOLS_FONTS_DIR`\n\nDirectory name relative to the static root where the files will be stored.\n\n> *Default*: `\"fonts\"`\n\n##### `WOOLS_STATIC_ROOT`\n\nAbsolute path to the static root that you want to use to store the fonts. If\nset to none, the first value from `STATICFILES_DIRS` will be used instead.\n\n> *Default*: `None`\n\n##### `WOOLS_FAMILIES`\n\nFont families that you want to load. It's a list of (provider, family) tuples.\n\nInstead of providing tuples, you can provide \n`django_wools.settings_types.FontFamily` instances directly. In case you don't\nprovide them, the tuple will be passed as *args to the constructor of\n`FontFamily`.\n\n> *Default*: `[]`\n\n##### `WOOLS_FONTS_PROVIDERS`\n\nDictionary of available font providers. The key is the name of the provider\nwhile the value is the FQN of the class.\n\nIf you want to provide your own provider, you can specifcy any class as long as\nit implements the `django_wools.fonts.WoolFontProvider` interface.\n\n> *Default*: `{\"google\": \"django_wools.fonts.GoogleFontsProvider\"}`\n\n##### `WOOLS_FONTS_FORMATS`\n\nList of font formats that you want. Choices are `ttf`, `woff`, `woff2`, `eot`,\n`svg`, `otf`. You can also directly provide instances of\n`django_wools.settings_types.FontFormat`.\n\nFont formats will be proposed in the same order to the browser.\n\n> *Default*: `[FontFormat.woff2, FontFormat.ttf]`\n\n##### `WOOLS_FONTS_CONVERSIONS`\n\nFont sources will provide the fonts in a given format (most likely TTF) but in\norder to produce the formats expected by `WOOLS_FONTS_FORMATS` you need to\nconvert those fonts.\n\nThis is a dictionary that as key takes a tuple of (from_format, to_format) and\nas value a sequential list of converters to use.\n\nBy example, suppose that you only have \"TTF to WOFF2\" and \"EOT to TTF\" avaible\nand your source is in EOT while formats are TTF and WOFF2. In that case you can\nspecificy that the conversion from \"EOT to WOFF2\" goes through TTF.\n\n> *Default*:\n\n```python\n{\n (FontFormat.ttf, FontFormat.woff): [\"django_wools.fonts.TtfToWoff\"],\n (FontFormat.ttf, FontFormat.woff2): [\"django_wools.fonts.TtfToWoff2\"],\n}\n```\n",
"bugtrack_url": null,
"license": "WTFPL",
"summary": "Django tools from WITH",
"version": "0.2.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b2394295c72e2427ddcbd7dad78e138e03f997b881bcac285782ff339e34712",
"md5": "6e5a9d7f63a3329c9a9b37b8e08655d3",
"sha256": "36b0aa50b3a0926cfddc3e92a5631021b589b48d076562ff19bae7270a20cb95"
},
"downloads": -1,
"filename": "django_wools-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e5a9d7f63a3329c9a9b37b8e08655d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6,<4.0",
"size": 18971,
"upload_time": "2023-01-15T23:20:21",
"upload_time_iso_8601": "2023-01-15T23:20:21.560510Z",
"url": "https://files.pythonhosted.org/packages/7b/23/94295c72e2427ddcbd7dad78e138e03f997b881bcac285782ff339e34712/django_wools-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21377d50ef5a7d2b28a286f96416d994ded4e812c0126344993c0d83a0c82cdc",
"md5": "2dfae9a0dabfd37667960f1a3a803649",
"sha256": "c2b068b29d59079eb540d9d3db69d49d39354d759c60799efd75e429b2869ef7"
},
"downloads": -1,
"filename": "django_wools-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "2dfae9a0dabfd37667960f1a3a803649",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6,<4.0",
"size": 19086,
"upload_time": "2023-01-15T23:20:22",
"upload_time_iso_8601": "2023-01-15T23:20:22.913055Z",
"url": "https://files.pythonhosted.org/packages/21/37/7d50ef5a7d2b28a286f96416d994ded4e812c0126344993c0d83a0c82cdc/django_wools-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-15 23:20:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "WithIO",
"github_project": "django-wools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "django-wools"
}
JSON
