Metadata-Version: 2.1
Name: converterpy
Version: 1.0.0
Summary: customizable converter tool to convert <source> to <target>
Home-page: https://github.com/bilalekremharmansa/converterpy
Author: Bilal Ekrem Harmansa
Author-email: bilalekremharmansa@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# converterpy

converterpy is designed as a customizable conversion tool to convert one thing to another.

# Usage

```bash
Usage:
  convert <value> <source> to <target> [-v|--verbose]
  convert <source> to <target> <value> [-v|--verbose]
  convert list [<source>] [-v|--verbose]
  convert --version

Options:
  -h --help        Show usage.
  -v --verbose     Enable verbose mode for debugging.
  --version        Show version.
```

#### Examples

```bash
$ convert 3600 seconds to minutes -> '60'
$ convert 3600 sec to min -> '60'
$ convert 2500 g to kg -> '2.5'
$ convert 1610744400 ts to date -> '2021-01-16 00:00:00'
$ convert 100 centimeter to meter -> '1'
```

# Features
There are some built-in converters to use;
- SITimeConverter (converts the following units: seconds, minutes, hours)
- SILengthConverter (converts the following units: millimeter, centimeter, meter, kilometer)
- SIMassConverter (converts the following units: milligram, gram, kilogram)
- TimestampDateConverter (converts unix timestamp to date, date to timestamp format)

### Installation

```converterpy``` requires Python 3.5+ to run.

Install with pip

```sh
$ pip install converterpy
```

### Custom Converters

Please follow the instructions in custom converter [documentation.][custom_converter.doc]


License
----

MIT

[custom_converter.doc]: <https://github.com/bilalekremharmansa/converterpy/blob/main/docs/custom_converters.md>

