Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddeutils/ddeutil-io
Input/Output transport utility objects
https://github.com/ddeutils/ddeutil-io
data-engineering data-utilities io package python3 utility
Last synced: 1 day ago
JSON representation
Input/Output transport utility objects
- Host: GitHub
- URL: https://github.com/ddeutils/ddeutil-io
- Owner: ddeutils
- License: mit
- Created: 2023-09-13T02:25:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T10:59:21.000Z (17 days ago)
- Last Synced: 2024-10-21T14:43:53.751Z (17 days ago)
- Topics: data-engineering, data-utilities, io, package, python3, utility
- Language: Python
- Homepage:
- Size: 362 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Input/Output Data Transport
[](https://github.com/korawica/ddeutil-io/actions/workflows/tests.yml)
[](https://codecov.io/gh/ddeutils/ddeutil-io)
[](https://pypi.org/project/ddeutil-io/)
[](https://pypi.org/project/ddeutil-io/)
[](https://github.com/korawica/ddeutil-io)
[](https://github.com/psf/black)
[](http://mypy-lang.org)
[](https://github.com/pre-commit/pre-commit)
The **Input/Output Data Transport** utility objects was created for full managed
engine of configuration file that include `load` from any config file format types
like `.yaml`, `.json`, or `.toml`, and manage retention and version of config files
lifecycle.
This package has 3 parts of core module; **Register**, **Stores**, and **Files**.
The base module is the file module that is open file objects with specific format
that want to open include open directory objects (I think the open dir object do
not should to use now because I do not done with its code.)
## :round_pushpin: Installation
```shell
pip install -U ddeutil-io
```
**Python version supported**:
| Python Version | Installation | Support Fixed Bug |
|----------------|-------------------------------|--------------------|
| `>=3.9,<3.14` | `pip install -U ddeutil-io` | :heavy_check_mark: |
> [!NOTE]
> This package need to install `ddeutil` first to be core package namespace.
> You do not need to pip it because I include this package to the required list.
>
> For optional dependencies that should to additional install;
>
> | Module | Additional dependencies |
> |------------|--------------------------|
> | YamlFl | `pip install PyYaml` |
> | TomlFl | `pip install toml` |
> | MsgpackFl | `pip install msgpack` |
## :dart: Features
The features of this package is Input/Output data transport utility objects.
| Module | Name | Description | Remark |
|------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------|----------|
| files | PathSearch | Path Search object that use to search path tree from an input root path. | |
| | RegexConf | Regular expression configuration object for this package. | |
| files.file | Fl | Open File object that use to open any normal or compression file from current local file system | |
| | EnvFlMixin | Environment Mapping to read method of open file object mixin. | |
| | EnvFl | Dot env open file object which mapping search engine to data context that reading from dot env file format (.env). | |
| | YamlEnvFl | Yaml open file object which mapping search environment variable. | |
| | YamlFl | Yaml open file object that read data context from Yaml file format (.yml, or .yaml). | |
| | YamlFlResolve | Yaml open file object with resolve boolean convert value problem such as convert 'on' value to true instead a string of 'on' value. | |
| | JsonEnvFl | Json open file object which mapping search environment variable before parsing with json package. | |
| | JsonLineFl | Json open file object that read data context from Json file format (.json) with a newline seperator. | |
| | JsonFl | Json open file object that read data context from Json file format (.json). | |
| | CsvFl | CSV open file object with comma (`,`) seperator charactor. | |
| | CsvPipeFl | CSV open file object with pipe (`\|`) seperator charactor. | |
| | TomlEnvFl | TOML open file object which mapping search environment variable before parsing with toml package from TOML file format (.toml). | |
| | TomlFl | TOML open file object that read data context from TOML file format (.toml). | |
| | PickleFl | Pickle open file object that read data context from Pickle file format (.pickle). | no cover |
| | MarshalFl | Marshal open file object that read data context from Marshal file format. | no cover |
| | MsgpackFl | Msgpack open file object that read data context from Msgpack file format. | no cover |
| stores | Store | Store File Loading Object for get data from configuration and stage. | |
| | StoreJsonToCsv | Store object that getting the Json context data and save it to stage with CSV file format. | |
| | StoreToJsonLine | Store object that getting the YAML context data and save it to stage with Json line file format. | |
| register | Register | Register Object that contain configuration loading methods and metadata management. | |
| | ArchiveRegister | Archiving Register object that implement archiving management on the Register object such as ``self.purge``, and ``self.remove`` methods. | |
## :beers: Usages
I will show some usage example of function in this package. If you want to use
complex or adjust some parameter, please see doc-string or real source code
(I think it do not complex and you can see how that function work).
### Files
For example, I will represent `YamlEnvFl` object that passing environment variable
to reading content before passing to the Yaml loader.
```yaml
data:
get: HELLO ${HELLO}
```
```python
import os
from ddeutil.io import YamlEnvFl
os.environ["HELLO"] = "WORLD"
content = YamlEnvFl('./source.yaml').read(safe=True)
assert content['data']['get'] == "HELLO WORLD"
```
> [!NOTE]
> This module do not implement special function on IO like the build-in ``open``
> function. It also make standard ``read`` and ``write`` file objects.
### Store
Store object is the storing dir system handler object that manage any files in
that dir path with `get`, `move`, `load`, `save`, or `ls` operations.
```python
from ddeutil.io.stores import Store
store: Store = Store(path='./conf', compress="gzip")
data = store.get(name='config_file.yaml')
store.save('./stage/file.json', data)
```
```text
conf/
examples/
config_file.yaml
stage/
file.json
```
### Register
The **Register Object** is the metadata generator object for the config data.
If you passing name and configs to this object, it will find the config name
in any stage storage and generate its metadata to you.
```python
from ddeutil.io.register import Register
from ddeutil.io.config import Params
registry: Register = Register(
name='examples:conn_data_local_file',
params=Params(**{
"stages": {
"raw": {"format": "{naming:%s}.{timestamp:%Y%m%d_%H%M%S}"},
},
}),
)
registry.move(stage="raw")
```
The raw data of this config was written in `conn_file.yaml` file.
```text
conf/
examples/
conn_file.yaml
```
When call `move` method, it will transfer data from `.yaml` file to `json` file
with the data hashing algorithm.
```text
data/
__METADATA/
exampleconn_data_local_file.base.json
exampleconn_data_local_file.raw.json
raw/
conn_file_20240101_000000.json
```