Skip to content

Commit b3c0268

Browse files
committed
1.0.1 release
1 parent 5cd72da commit b3c0268

File tree

2 files changed

+49
-26
lines changed

2 files changed

+49
-26
lines changed

README.md

Lines changed: 48 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -93,16 +93,17 @@ In your Django HTML template, reference the CSS file as normal:
9393

9494
✨✨ **Congratulations, you are now a Django + Sass developer!** ✨✨
9595

96-
Now you can commit those CSS files to version control, or run `collectstatic` and deploy them as normal.
96+
Now you can commit those CSS files to version control, or run `collectstatic`
97+
and deploy them as normal.
9798

9899
For an example project layout, see `testproject/` in this repository.
99100

100101

101102
Watch Mode
102103
----------
103104

104-
To have `django-sass` watch files and recompile them as they change (useful in development),
105-
add the ``--watch`` flag.
105+
To have `django-sass` watch files and recompile them as they change (useful in
106+
development), add the ``--watch`` flag.
106107

107108
```
108109
python manage.py sass app2/static/app2/scss/ app2/static/app2/css/ --watch
@@ -133,10 +134,11 @@ And now proceed with deploying your files as normal.
133134
Limitations
134135
-----------
135136

136-
* `@import` statements must reference a path relative to a path in `STATICFILES_FINDERS`
137-
(which will usually be an app's `static/` directory or some other directory specified
138-
in `STATICFILES_DIRS`). Or they can reference a relative path equal to or below the
139-
current file. It does not support traversing up the filesystem (i.e. `../`).
137+
* `@import` statements must reference a path relative to a path in
138+
`STATICFILES_FINDERS` (which will usually be an app's `static/` directory or
139+
some other directory specified in `STATICFILES_DIRS`). Or they can reference a
140+
relative path equal to or below the current file. It does not support
141+
traversing up the filesystem (i.e. `../`).
140142

141143
Legal imports:
142144
```scss
@@ -151,31 +153,43 @@ Limitations
151153

152154
* Only files ending in `.scss` are supported for now.
153155

154-
* Only supports `-g`, `-p`, and `-t` options similar to `pysassc`. Ideally `django-sass` will
155-
be as similar as possible to the `pysassc` command line interface.
156+
* Only supports `-g`, `-p`, and `-t` options similar to `pysassc`. Ideally
157+
`django-sass` will be as similar as possible to the `pysassc` command line
158+
interface.
156159

157-
Feel free to file an issue or make a pull request to improve any of these limitations. 🐱‍💻
160+
Feel free to file an issue or make a pull request to improve any of these
161+
limitations. 🐱‍💻
158162

159163

160164
Why django-sass?
161165
----------------
162166

163-
Other packages such as [django-libsass](https://github.com/torchbox/django-libsass)
164-
and [django-sass-processor](https://github.com/jrief/django-sass-processor),
165-
while nice packages, require `django-compressor` which itself depends on several
166-
other packages that require compilation to install.
167-
168-
* If you simply want to use Sass in development without installing a web of unwanted
169-
dependencies, then `django-sass` is for you.
170-
* If you don't want to deploy any processors or compressors to your production server,
171-
then `django-sass` is for you.
167+
Other packages such as
168+
[django-libsass](https://github.com/torchbox/django-libsass) and
169+
[django-sass-processor](https://github.com/jrief/django-sass-processor), while
170+
nice packages, require `django-compressor` which itself depends on several other
171+
packages that require compilation to install.
172+
173+
Installing `django-compressor` in your production web server requires a LOT of
174+
extra bloat including a C compiler. It then will compile the Sass on-the-fly
175+
while rendering the HTML templates. This is a wasteful use of CPU on your web
176+
server.
177+
178+
Instead, `django-sass` lets you compile the Sass locally on your machine
179+
*before* deploying, to reduce dependencies and CPU time on your production web
180+
server. This helps keep things fast and simple.
181+
182+
* If you simply want to use Sass in development without installing a web of
183+
unwanted dependencies, then `django-sass` is for you.
184+
* If you don't want to deploy any processors or compressors to your production
185+
server, then `django-sass` is for you.
172186
* If you don't want to change the way you reference and serve static files,
173187
then `django-sass` is for you.
174-
* And if you want the absolute simplest installation and setup possible for doing Sass,
175-
`django-sass` is for you too.
188+
* And if you want the absolute simplest installation and setup possible for
189+
doing Sass, `django-sass` is for you too.
176190

177-
django-sass only depends on libsass (which provides pre-built wheels for Windows, Mac,
178-
and Linux), and of course Django (any version).
191+
django-sass only depends on libsass (which provides pre-built wheels for
192+
Windows, Mac, and Linux), and of course Django (any version).
179193

180194

181195
Programmatically Compiling Sass
@@ -233,6 +247,7 @@ venv, then:
233247
Before committing, run static analysis tools:
234248

235249
```
250+
(myvenv)$ black .
236251
(myvenv)$ flake8
237252
(myvenv)$ mypy
238253
```
@@ -247,17 +262,25 @@ Then run the unit tests:
247262
Changelog
248263
---------
249264

265+
#### 1.0.1
266+
* Maintanence release, no functional changes.
267+
* Add additional type hints within the codebase.
268+
* Tested against Django 3.1
269+
* Formatted code with `black`.
270+
250271
#### 1.0.0
251272
* New: You can now use `django_sass` APIs directly in Python.
252273
* Added unit tests.
253274
* Code quality improvements.
254275

255276
#### 0.2.0
256-
* New feature: `-g` option to build a source map (when input is a file, not a directory).
277+
* New feature: `-g` option to build a source map (when input is a file, not a
278+
directory).
257279

258280
#### 0.1.2
259281
* Fix: Write compiled CSS files as UTF-8.
260-
* Change: Default `-p` precision from 5 to 8 for better support building Bootstrap CSS.
282+
* Change: Default `-p` precision from 5 to 8 for better support building
283+
Bootstrap CSS.
261284

262285
#### 0.1.1
263286
* Fix: Create full file path if not exists when specifying a file output.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
setup(
1111
name="django-sass",
12-
version="1.0.0",
12+
version="1.0.1",
1313
author="CodeRed LLC",
1414
author_email="[email protected]",
1515
url="https://github.com/coderedcorp/django-sass",

0 commit comments

Comments
 (0)