Changelogs » Serialix

PyUp Safety actively tracks 382,903 Python packages for vulnerabilities and notifies you when to upgrade.

Serialix

2020.11.18

Changed
  - Changed version to `1.0.0`
  - `.core.BaseLang` methods inheritance modified a bit
  - Github workflows prepared for release state
  
  Fixed
  - Documentation folder name for github page build
  - Link to documentation page in main `README.rst`
  
  Removed
  - Posfix for documentation display version

2020.11.17

Added
  - `.core.BaseLang`
  - `refresh()` and `reload()` now will return `bool` value
  - Root makefile target to publish the package
  
  Fixed
  - `.core.*`
  - `BaseLang.copy()` and `recursive_dicts_merge()` copy was fixed with `copy.deepcopy()` module to remove all references to original dictionary
  - `ModuleNotFoundError` exception on importing `serialix` without external package installed
  
  Changed
  - Version changed to `1.0.0dev1` for test release purpose
  - Changed to `1.0.0dev2`
  - Replaced all `"` quotation marks with `'`
  - Enhanced the docstrings for `.core`
  - Enhanced docs structure
  - Makefile usage added to `release.yml` workflow

2020.11.16

Added
  - README to `./examples/` dir
  
  Fixed
  - `.core.recursive_dicts_merge()` was not merging anything
  
  Changed
  - Docs version postfix = `_predocs`. Will be removed on release.
  - Enhanced docs
  - Docs makefile now will create `_static` dir on run, if it doesn't exist
  
  Removed
  - `:ref:` from docs. Replaced with html links.

2020.11.15

Added
  - Project root makefile containing options to build the package and documentation
  
  Changed
  - Project classifiers `Development Status` to `5 - Production/Stable`
  
  Removed
  - `XML` and `INI` support cutted due to unfinished state. Realisation code moved to repo branch `dev/lang_support`

2020.11.14

Added
  - Started implementation of `INI` dif language support with full tests support
  - Created and almost finished function `.core.parse_dict_values()`
  
  Changed
  - Enhanced main package `__init__`
  - README and docs 'Supported Languages' changed
  - Changed 'about' info in README and docs
  
  Removed
  - Variable converting in `.tests.core` due to `.core.parse_dict_values()` is almost ready to implement

2020.11.13

Added
  - Docstrings at the beginning of each `.langs` module, describing its purpose.
  
  Changed
  - Renamed the `.configs` subpackage to `.langs`
  - Renamed `.core.BaseInterchange` to `.core.BaseLang`
  - Renamed `.tests.BaseConfigTest` to `.tests.BaseLangTest`
  - Renamed the variable `.tests.*::self.config` to `.tests.*::self.language_object`
  - Modified `.core.BaseLang` docstrings
  - Enhanced the 'about' description in README and docs

2020.11.12

Added
  - Support for `XML` language with unit testing suite
  
  Changed
  - Renamed some variables in tests core
  - Added information about `XML` language to `README.rst` and docs
  - Adjusted `setup.py` to support new `XML` language feature

2020.11.10

Added
  - New `safe_mode` feature to `.core.BaseConfiguration.refresh()` with tesing suite modifications
  - Links to *docs* and *bug tracker* to `setup.py` script
  - What version of `configurio` is docs for and revision time in index page
  
  Changed
  - Project version to `1.0.0` (Preparing for the release)
  - Enhanced *installation guide* section in docs

2020.11.09

Added
  - Basic documentation *(WIP)*
  - `.core.BaseConfiguration`
  - Added iterator support
  - Created simple example usage of this package as a CLI tool
  
  Fixed
  - Optional argument `default_config` in `.core.BaseConfiguration` is now really optional. Yeah.
  - Methods `pop()` and `popitem()` in `.core.BaseConfiguration` now will return values as expected.
  
  Changed
  - `.core.BaseConfiguration`
  - `refresh()` now will merge all changes to config dictionary without overwriting the nested dicts
  - Renamed `reset_to_file()` method to `reload()`

2020.11.04

Added
  - `Yaml` support *(<=1.2)* with [`ruamel.yaml`](https://pypi.org/project/ruamel.yaml/) module. `PyYaml` support dropped. Tests added.
  - `.core.BaseConfiguration` additions:
  - `dict` methods to work with `__configuration_dict`
  - Added getters and setters for `__configuration_dict` and `__default_local_file_dict`
  - Custom markers `yaml` and `json` to PyTest configuration
  - `test` bundle to `setup.py`'s `extras_require` with all necessary for testing packages
  
  Fixed
  - Existing files will no longer be overwritten with values from the default dictionary on object initialization
  
  Changed
  - Unit tests suite modified to current changes and enhanced
  - `.core.BaseConfiguration.__init__()`:
  - `default_config` argument is now optional
  - `create_if_not_found` argument removed
  
  Removed
  - Got rid of the object model access and switched to dict support
  - Useless version range lock from `requirements-dev.txt` and `setup.py`
  - Removed logging module support
  - `.core.BaseConfiguration` removals:
  - `reset_file_to_defaults()` method
  - `__repr__()` method

2.0.1

> This QOL *(Quality Of Life)* update is focused on updating the external packages version locks and enhancing the overall package quality with documentation, unit-testing and other features updated.
  
  Changed
  - Updated the YAML language parser ([`ruamel.yaml`](https://pypi.org/project/ruamel.yaml/)) support to the latest version `0.17.20`
  - Updated the [`ujson`](https://pypi.org/project/ujson/) support up to the latest `5.1.0` version

2.0.1a1

Changed
  - Updated the YAML language parser ([`ruamel.yaml`](https://pypi.org/project/ruamel.yaml/)) support to the latest version *(0.17.20)*
  - Updated the [`ujson`](https://pypi.org/project/ujson/) supported version up to the latest `5.1.0`

2.0.0

Changed
  - Project renamed to ``serialix``

1.3.2

Notification
  ⚠ `interform` will be renamed to `serialix` from version **2.0.0**

1.3.1

Fixed
  - Docstrings for `serialix.core.BaseLang`

1.3.0

Added
  - Command Line Interface *(CLI)* toolset with documentation
  - Format converter tool

1.3.0a1

Added
  - Command Line Interface *(CLI)* toolset with documentation
  - Format converter tool

1.2.0

Added
  - Keyword argument `auto_file_creation` to all `*_Format` classes which will allow to disable the automatic local file creation on `*_Format` object initialization
  
  Changed
  - In `*_Format` classes, instead of only `.create_file()` method, all directories generation now placed in `write_dict_to_file()` method. This change will affect all 'write to file' actions and prevent all path related issues.

1.2.0a2

Changed
  - In `*_Format` classes, instead of only `.create_file()` method, all directories generation now placed in `write_dict_to_file()` method. This change will affect all 'write to file' actions and prevent all path related issues.

1.2.0a1

Added
  - Keyword argument `auto_file_creation` to all `*_Format` classes which will allow to disable the automatic local file creation on `*_Format` object initialization
  
  Changed
  - ~~`.create_file()` method in all `*_Format` classes will now automatically create all detected dirs in path to local file~~

1.1.2

Fixed
  - `.values` method in all `*_Format` classes will now return expected value. Before the fix, this method returned the values of bound to object default dictionary.

1.1.1

Fixed
  - `.reload()` method return now works properly in all `*_Format` classes

1.1.0

Added
  - Support for `TOML` language
  - Feature to pass custom arguments to parser on read and write actions with `parser_write_kwargs` and `parser_read_kwargs`
  
  Fixed
  - Fixed new key creation from main object issue
  
  Changed
  - Method of handling import requests in init script
  - `_core__write_dict_to_file` and `_core__read_file_to_dict` are no more static methods in `.core.BaseLang` and inherited classes
  - Enhanced documentation
  
  Removed
  - Advanced `JSON_Format` parser arguments removed

1.1.0a2

Added
  - Feature to pass custom arguments to parser on read and write actions with `parser_write_kwargs` and `parser_read_kwargs`
  
  Changed
  - `_core__write_dict_to_file` and `_core__read_file_to_dict` are no more static methods in `.core.BaseLang` and inherited classes
  - Enhanced documentation

1.1.0a1

Added
  - Support for `TOML` language
  
  Fixed
  - Fixed new key creation from main object issue
  
  Changed
  - Method of handling import requests in init script
  
  
  ---------
  
  <details>
  <summary>Pre-Release Development Changelog</summary>
  
  > In this part of changelog you can track the progress of development before the public `1.0.0` version release.

1.0.0

> First public release of this package
  
  
  Development Releases

0.0.2dev2

> This version was the last attempt to create object model configuration files. I decided to give up this idea, because the realisation of this feature was awful.
  
  Added
  - Feature to extend the current configuration object with dictionaries
  - Create nested attributes in object without any dicts usage
  - Example:
  python
  >>> cfg = Configuration()
  >>> cfg.test.nested.d = "yes"
  >>> cfg.test.nested.d
  'yes'
  
  
  Changed
  - Split configuration files controllers by type in submodule `.configs`
  - Enhanced unit tests coverage
  - Moved unit tests to project directory
  - Renamed some methods to more friendly variants
  
  Fixed
  - `.core.BaseController.clear()` implementation fixed
  - `.core.Namespace.__getitem__()` behaviour fixed

0.0.2dev1

Added
  - `clear` method to `.core.BaseController`
  - proto for new function `.core.dict_to_namespace()`
  
  Changed
  - Fully refactored the config system
  - New way of interacting with configurations: `Configuration` and `Controller`
  - Values now will be stored in `Configuration` class
  - All methods now located in `*Controller` classes
  - Updated unit tests to new code
  
  </details>