maximilionus/serialix

Powerful and easy to use api for working with various human-readable data serialization formats

serialix's Issues

Create project logotype

Would be a nice addition to create logo for this project. It can be used as icon for README, Docs and other things.

Logging support

This tool should at least log actions with logging built-in module.

Add get version feature to CLI toolset

Should add version print feature to serialix cli, accessible by passing the --version argument on cli startup.

Docstrings enhancement

Docstrings "about" part should give more information about usage. Examples of a bad explanation below

serialix/serialix/core.py

Line 79 in ce26b22

""" Clear the bound ``dictionary`` """

serialix/serialix/core.py

Line 101 in ce26b22

"""Get key from ``dictionary``

serialix/serialix/core.py

Line 114 in ce26b22

"""Get items of the ``dictionary``

serialix/serialix/core.py

Line 179 in ce26b22

"""Update ``dictionary`` with another dictionary

Docs Makefile enhancement

serialix/Makefile

Line 15 in 37baf53

@$(PYTHON) ./setup.py install

This line can be removed because project self dependence is already specified in requirements-dev.txt

serialix/requirements-dev.txt

Lines 9 to 10 in 483ac87

	# Project
	-e .

.core.BaseLang.refresh(safe=True) does not work as expected

Noticed this issue while working on examples for documentation. .core.BaseLang.refresh(safe=True) does not refresh anything from local file. Probably some issues with recursive merge function .core.recursive_dicts_merge()

Steps to reproduce:

1. Create local file settings.json with content

{
    "version": 5,
    "app_name": "Super Secret Tool",
    "our_new_key": {
        "type": "msg",
        "id": 34724889325,
        "text": "wassup?"
    }
}

2. In interpreter, prepare the JSON_Format object

from interform import JSON_Format


config = JSON_Format('settings.json')

3. Manually add new key to settings.json

{
    "version": 5,
    "app_name": "Super Secret Tool",
    "our_new_key": {
        "type": "msg",
        "id": 34724889325,
        "text": "wassup?"
    },
    "proverka": true
}

4. Execute refresh method on object and try to get value

config.refresh(safe=True)
config['proverka']

KeyError: 'custom_key'

Docs meta tags

Add meta tags to documentation head with RST built-in feature.

List of tags:
description - short information
encoding - already present in index page head

Outdated test suite

interform's unit tests were designed and coded in early stages of development and were modified a lot of times from that moment. In current state of the project, these tests do not cover all features, and most of them can be compressed due to their uselessness.

Add built package testing to Actions

There should be also implemented ci feature to test package build process and final dist results

CLI toolset standalone package

As the title says - would be nice to deprecate the cli toolset in version 3.0.0 and publish it as a standalone package. Built-in cli is bloating this package because of it's uselessness in most default usage cases.

Raise NotImplementedError on BaseLang core methods

NotImplementedError exception should be raised on attempt to use _core__read_file_to_dict and _core__write_dict_to_file methods directly from .core.BaseLang class because these methods must be implemented separately for each language

Option to build docs from directory

When it comes to testing the documentation on local machine it's very inconvenient to do because all changes to project docstrings requires to be commited first to be then used by documentation makefile. Documentation makefile currently supports only build from branch mode without any other options.

There should be an option to use local directory as project source for documentation makefile, available with something like from_dir env. variable. This will allow to use the main project files from another directory, placed somewhere near the documentation immediately after their modification.

Start point for this feature is already created in make.sh, yet no implementation

serialix/make.sh

Lines 45 to 49 in b62deee

	else
	# TODO realisation of build from dir feature
	#echo "[ Obtaining project from '$from_dir' directory ]"
	echo "Not implemented yet :("; exit 1
	fi