Metadata-Version: 2.1
Name: fconv
Version: 1.0.2
Summary: Converter between multiple open-standard file formats.
Home-page: https://github.com/wf001/fconv
Author: wf001
Author-email: wf001@diax.xyz
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# fconv
Python lib and CLI command that convert between multiple file formats

## Getting started
```
pip install fconv
```

```
$ fconv --v
version: x.x.x
```

## Features
- Converting a file into other formatted file

- Supportting format 
	- json
	- yaml
	- on going
		- xml
		- toml
		- ini


- In condition of using as a module, fconv supports optional arguments.

To know which options are available,

See the reference:

- json:https://docs.python.org/3/library/json.html
- yaml:https://pyyaml.org/wiki/PyYAMLDocumentation

## Example
### Use as a module
```
>>> from fconv.core import Former
>>> from fconv.formats.json import Json
>>> from fconv.formats.yaml import Yaml
>>> f = Former(src_format=Json, target_format=Yaml)

>>> f.form('{"key1":"value1"}')
'key1: value1\\n'

>>> f = Former(src_format=Yaml, target_format=Json, out_opt={'indent':3})
>>> f.form('key1: value1\\n')
'{\\n   "key1": "value1"\\n}'
```

### Use as a CLI command
Basic usage
```
fconv <source format> <target format> -i <source file name>
```

Convert json file into yaml and print out
```
fconv json yaml -i sample.json
```

Convert yaml file into json formated file
```
fconv yaml json -i sample.yaml -o result.json
```

### License
Licensed under the MIT License.


