Cerbernetix.toolbox

Added

- `get_combinations(values, length, start, stop, step, offset, indexes)`: Computes combinations given a set of values and a length.
- `minmax(*args)`: Returns with the min and the max value from the given arguments.
- `quantity(quota, total)`: Gets a quantity with respect to a quota applied to a total.

Changed

- Add options to JSONFile implementation (`sort_keys`, `skip_keys`, `ensure_ascii`, `separators`, `strict`).
- Set the default CSV dialect to `'excel'` when writing (this reflects the default value from the Python library).
- Set the default CSV dialect to `'auto'` when reading (the dialect will be sniffed from the first few rows).

Fixed

- Fix the link to the documentation in the readme.
- Inconsistent return value in the log action.
- Too many branches and returns in the file checker.
- A few linter issues.
- Typo in the instructions for the installation in dev mode.

Fixed

- Correct the readme instructions for installing the package.

Changed

- Move the package to the `cerbernetix` namespace.
- Move the package to the `src` directory.
- `FileManager.read_file(iterator)` - Accepts to return an iterator from `read_file()` instead of immediately the content.

Added

- `get_combination_rank(combination, offset)`: Gets the rank of a combination.
- `get_combination_from_rank(rank, length, offset)`: Gets the combination corresponding to a particular rank.
- `get_cache_path(name, create)` - Gets the path to a cache folder.
- `ValueExtractor(entries, mapper)` - A tool for extracting values from a set of possible entries.
- `decimal(separator, thousands)` - Creates a mapper for casting decimal values to floats.
- `Weekday(day)` - Gets the date of a weekday given a particular date.
- `FileManager.create_path()` - Creates the parent path of the file.
- `FileManager.check(...)` - Tells if the file is valid with respect to the specified criteria.

Added

- Script for running the unit tests and presenting the coverage.
- Script for applying the linter.
- Script for applying the formatting.

Fixed

- Correct the dependencies declaration.

Changed

- Move the tests to a dedicated folder outside of the source code. This will avoid polluting the exports.

Fixed

- Better default value for the config option mapper (None instead of a default mapper function).

Changed

- `read_pickle_file(...)` and `PickleFile.read_file()` - Can either return a list (default) or an iterator (when the iterator parameter is True).
- `read_csv_file(...)` and `CSVFile.read_file()` - Can either return a list (default) or an iterator (when the iterator parameter is True).
- `read_zip_csv(buffer, ...)` - Can either return a list (default) or an iterator (when the iterator parameter is True).