[1.6.0] Release

Author: sveetch

docs/changelog.rst

@@ -5,7 +5,7 @@
 Changelog
 =========
 
-Version 1.6.0 - 2021/02/01
+Version 1.6.0 - 2021/02/04
 --------------------------
 
 *Last Python2 support, compatibility for recent Click versions and improve

docs/index.rst

@@ -22,7 +22,8 @@ Features
 ********
 
 * Stand on `LibSass`_ which is **very fast**;
-* **Per project configuration** so you can use it once to compile all of your Sass files from a same project;
+* **Per project configuration** so you can use it once to compile all of your
+  Sass files from a same project;
 * **Simple and useful** command line;
 * **Watch mode** for no waste of time during web design integration;
 * **Full Python stack**, no Ruby or Node.js stuff needed;

docs/overview.rst

@@ -9,44 +9,62 @@
 Overview
 ========
 
-Boussole is working on **per-project configuration**, it means all your Sass sources to compile have to be organized in the same directory considered as the *sources directory*. Obviously you can organize them in multiple sub-directories within your sources directory.
+Boussole is working on **per-project configuration**, it means all your Sass
+sources to compile have to be organized in the same directory considered as the
+*sources directory*. Obviously you can organize them in multiple sub-directories within your sources directory.
 
-Your project can rely on some **Sass libraries that must be out of the source directory** to be defined in option ``LIBRARY_PATHS``.
+Your project can rely on some **Sass libraries that must be out of the source
+directory** to be defined in option ``LIBRARY_PATHS``.
 
-Boussole does not really handle itself compilation, this is the role of `libsass-python`_. But for watch mode Boussole needs to inspect your Sass sources and so can raise some errors if they are invalid. These errors will be almost only about your ``@import`` rules.
+Boussole does not really handle itself compilation, this is the role of
+`libsass-python`_. But for watch mode Boussole needs to inspect your Sass sources
+and so can raise some errors if they are invalid. These errors will be almost only
+about your ``@import`` rules.
 
-**Boussole is builded following Sass references** and all your Sass sources and libraries compatibles with libsass should be safe to compile.
+**Boussole is builded following Sass references** and all your Sass sources and
+libraries compatibles with libsass should be safe to compile.
 
 
 Project configuration
 *********************
 
-A project **configuration lives in a file** which default attempted name is ``settings.json`` (JSON backend) or ``settings.yml`` (YAML backend).
+A project **configuration lives in a file** which default attempted name is
+``settings.json`` (JSON backend) or ``settings.yml`` (YAML backend).
 
 Backend format
 --------------
 
-There is actually two supported backend format: JSON and YAML. Each of backend format expect is own default filename.
+There is actually two supported backend format: JSON and YAML. Each of backend
+format expect is own default filename.
 
-However you can ask for a specific backend from command line use argument ``--backend``, value can be either ``json`` or ``yaml``.
+However you can ask for a specific backend from command line use argument
+``--backend``, value can be either ``json`` or ``yaml``.
 
 Discovering
 -----------
 
-Boussole is able to discover your settings file if you don't explicitely give it as command argument with ``--config`` option.
+Boussole is able to discover your settings file if you don't explicitely give it
+as command argument with ``--config`` option.
 
-Discovering is allways performed from current directory and will try to find a settings file using available backend default filename.
+Discovering is allways performed from current directory and will try to find a
+settings file using available backend default filename.
 
-Such as if you have a ``settings.yml`` in your current directory, Boussole will assume it's your settings file to open. JSON backend is the first one to be checked so if you have both ``settings.json`` and ``settings.yml`` in your current directory, the JSON will be used.
+Such as if you have a ``settings.yml`` in your current directory, Boussole will
+assume it's your settings file to open. JSON backend is the first one to be
+checked so if you have both ``settings.json`` and ``settings.yml`` in your current
+directory, the JSON will be used.
 
-You may possibly enforce a single backend to be used in discovery using the ``--backend`` option.
+You may possibly enforce a single backend to be used in discovery using the
+``--backend`` option.
 
-Finally, if you give an explicit settings file path with ``--config`` there will be no discovering, Boussole will just open it directly.
+Finally, if you give an explicit settings file path with ``--config`` there will
+be no discovering, Boussole will just open it directly.
 
 Sample
 ------
 
-Here is a full sample of available settings for project configuration with JSON format:
+Here is a full sample of available settings for project configuration with JSON
+format:
 
     .. sourcecode:: json
 
@@ -70,7 +88,8 @@ References
 ----------
 
 .. Note::
-    Default values are referenced as Python values, you will need to adapt them according to the backend format you are using.
+    Default values are referenced as Python values, you will need to adapt them
+    according to the backend format you are using.
 
 
 SOURCES_PATH
@@ -80,29 +99,40 @@ SOURCES_PATH
 LIBRARY_PATHS
     Default: ``[]``
 
-    (list) A list of paths (string) to your library imported from your Sass sources. Never try to add your source dir as a library and vice versa, this will trouble resolver and compiler.
+    (list) A list of paths (string) to your library imported from your Sass sources.
+    Never try to add your source dir as a library and vice versa, this will trouble
+    resolver and compiler.
 
-    If you plan to use some Sass libraries installed from npm, just add the path to ``node_modules`` directory, then you will be able to import them from your sources.
+    If you plan to use some Sass libraries installed from npm, just add the path to
+    ``node_modules`` directory, then you will be able to import them from your
+    sources.
 TARGET_PATH
     Default: None, this is a required setting.
 
     (string) Directory path where will be writed your compiled Sass sources.
 OUTPUT_STYLES
     Default: ``nested``
 
-    (string) keyword of output style type used to compile your Sass sources. Can be either ``compact``, ``expanded``, ``nested`` or ``compressed``.
+    (string) keyword of output style type used to compile your Sass sources. Can
+    be either ``compact``, ``expanded``, ``nested`` or ``compressed``.
 SOURCE_COMMENTS
     Default: ``False``
 
-    (boolean) If ``True``, comments about source lines will be added to each rule in resulted CSS from compile.
+    (boolean) If ``True``, comments about source lines will be added to each rule
+    in resulted CSS from compile.
 SOURCE_MAP
     Default: ``False``
 
-    (boolean) If ``True``, generate a source map for each compiled file. Source map filename will be the same that compiled file but with extension changed to ``.map``. The source map file is allways created in the same directory than CSS file.
+    (boolean) If ``True``, generate a source map for each compiled file. Source map
+    filename will be the same that compiled file but with extension changed to
+    ``.map``. The source map file is allways created in the same directory than CSS
+    file.
 EXCLUDES
     Default: ``[]``
 
-    (list) A list of glob pattern (string) to exclude some paths/files from compile. Remember these pattern are allways matched against relative paths (from project directory).
+    (list) A list of glob pattern (string) to exclude some paths/files from compile.
+    Remember these pattern are allways matched against relative paths (from project
+    directory).
 
 
 Help
@@ -120,9 +150,12 @@ And you can reach help about command options using: ::
 Start a new project
 *******************
 
-Create directory and configuration file for a new project. Although you can create your project manually, this is an easy helper to do it and avoid forgetting some details.
+Create directory and configuration file for a new project. Although you can create
+your project manually, this is an easy helper to do it and avoid forgetting some
+details.
 
-Without arguments, command will prompt you to fill required values but you can also directly feed these values from arguments, see command help for details.
+Without arguments, command will prompt you to fill required values but you can
+also directly feed these values from arguments, see command help for details.
 
 **Usage** ::
 
@@ -132,7 +165,8 @@ Without arguments, command will prompt you to fill required values but you can a
 Compile
 *******
 
-Compile simply launch compiler on every eligible Sass source from your ``SOURCES_PATH`` directory.
+Compile simply launch compiler on every eligible Sass source from your
+``SOURCES_PATH`` directory.
 
 **Usage** ::
 
@@ -142,9 +176,11 @@ Compile simply launch compiler on every eligible Sass source from your ``SOURCES
 Watch
 *****
 
-Watcher will constantly watch about changes on files in your ``SOURCES_PATH`` directory.
+Watcher will constantly watch about changes on files in your ``SOURCES_PATH``
+directory and ``LIBRARY_PATHS`` paths.
 
-When an event occurs, it will compile eligible sources from the file dependencies and itself.
+When an event occurs, it will compile eligible sources from the file itself to
+its dependencies.
 
 Managed events can be :
 
@@ -153,21 +189,32 @@ Managed events can be :
 * File move;
 * File deletion.
 
-Event about directories (like directory creation or moving) are ignored.
+.. Note::
+    Event about directories (like directory creation or moving) are ignored.
 
 .. Note::
-    Compile errors won't break the watcher so you can resolve them and try again to compile.
+    Compile errors won't break the watcher so you can resolve them and try again
+    to compile.
 
 
 **Usage** ::
 
     boussole watch
 
 .. Note::
-    Default behavior is to use the Watchdog native platform observer. It may not work for all environments (like on shared directories through network or Virtual machine), in this case use the ``--poll`` to use the Watchdog polling observer instead of the default one.
-
-Boussole has its own internal code to inspect Sass sources to be aware of sources paths it has to watch for.
-
-In some rare circumstances inspection may lead to issues where ``compile`` command can build your sources but can fails with ``watch`` command because the latter need to inspect sources to be able to find dependencies and choke on unclear path resolution.
-
-These unclear paths are almost allways due to some Sass libraries trying to import components using a relative path outside of itself like with ``../``. This is often the case with libraries that have been made to be included in your main scss directory.
+    Default behavior is to use the Watchdog native platform observer. It may not
+    work for all environments (like on shared directories through network or Virtual
+    machine), in this case use the ``--poll`` to use the Watchdog polling observer
+    instead of the default one.
+
+Boussole has its own internal code to inspect Sass sources to be aware of sources
+paths it has to watch for.
+
+In some rare circumstances, some source inspection may lead to issues where ``compile``
+command can build your sources but can fails with ``watch`` command because the latter
+need to inspect sources to be able to find dependencies and choke on unclear path
+resolution.
+
+These unclear paths are almost allways due to some Sass libraries trying to import
+components using a relative path outside of itself like with ``../``. This is often
+the case with libraries that have been made to be included in your main scss directory.

requirements_freeze.txt

@@ -1,10 +1,10 @@
 # Pinned versions during last development installation
-six==1.14.0
-click==5.1
+six==1.15.0
+click==7.1.2
 pathtools==0.1.2
-watchdog==0.10.2
-libsass==0.20.0
+watchdog==1.0.2
+libsass==0.20.1
 pyaml==20.4.0
-PyYAML==5.3.1
-colorama==0.4.3
-colorlog==4.1.0
+PyYAML==5.4.1
+colorama==0.4.4
+colorlog==4.7.2