Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/caian-org/coin

currency conversion CLI
https://github.com/caian-org/coin

cli crystal currency-conversion exchange

Last synced: 3 months ago
JSON representation

currency conversion CLI

Awesome Lists containing this project

README

        

[![Made with Crystal][crystal-shield]][crystal-url]
[![Build & Test][gh-bnt-shield]][gh-bnt-url]
[![Release][gh-release-shield]][gh-release-url]
[![GitHub tag][tag-shield]][tag-url]

# `coin`: currency conversion CLI

CLI to perform currency conversions via the [Fixer API](https://fixer.io).

- Able to convert monetary values up to 168 different currencies
- Available as a single binary, no external dependencies needed

[crystal-shield]: https://img.shields.io/badge/Made%20with-Crystal-1f425f.svg?style=flat-square&logo=crystal&logoColor=FFF
[crystal-url]: https://crystal-lang.org/

[gh-bnt-shield]: https://img.shields.io/github/workflow/status/caian-org/coin/build-and-test?label=build%20%26%20test&logo=github&style=flat-square
[gh-bnt-url]: https://github.com/caian-org/coin/actions/workflows/build-and-test.yml

[gh-release-shield]: https://img.shields.io/github/workflow/status/caian-org/coin/release?label=release&logo=github&style=flat-square
[gh-release-url]: https://github.com/caian-org/coin/actions/workflows/release-all.yml

[tag-shield]: https://img.shields.io/github/tag/caian-org/coin.svg?logo=git&logoColor=FFF&style=flat-square
[tag-url]: https://github.com/caian-org/coin/releases

## Table of Contents

- [Usage](#usage)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)

## Usage

### Help

```
user@host:~$ coin -h

Usage: coin [-h] [-v] amount origin

Positional arguments:
amount The amount of money to be converted
origin The origin currency used as base for conversion
target Each of the target currencies for conversion

Optional arguments:
-h, --help Show this help message and exit
-v, --version Show the program version and exit

Examples:
$ coin 1 usd brl
# => converts 1 us dollar to brazilian real

$ coin 2.5 eur rub jpy
# => converts 2.5 euro to russian rouble and japanese yen

This project is dedicated to the Public Domain (CC0).

Project page:
```

For a comprehensive list of all available currencies, see
[`docs/currencies.rst`](docs/currencies.rst).

### Fixer API token

Coin highly depends on Fixer, a _"foreign exchange rates and currency conversion
JSON API"_. Fixer gives a free tier that allows up to a 1000 requests per month.
In order to get an API key and use the service, an account is required. You can
sign up for a free account [here](https://fixer.io/signup/free).

The API key is a 32-length characters wide alphanumeric string. Coin must read
this API key in order to make the request and parse it. It will, by default,
try to read the key from the `FIXER_API_TOKEN`.

- __Export the API key:__

```sh
$ export FIXER_API_TOKEN="ys1r39m5zc71xpvdjpqsnrhwqtxe98cj"
```

## Installation

### Pre-built

The pre-built binaries are available at the [release page](https://github.com/caian-org/coin/releases).
Download the most recent version for you system, give the binary execution
permissions and move to a directory on the `$PATH`.

```sh
# to download the macos binary, change "coin-linux" to "coin-macos"
$ wget https://github.com/caian-org/coin/releases/download/v0.2.0/coin-linux -O coin
$ chmod +x coin
$ (sudo) mv coin /usr/bin
```

### From source

Coin is implemented in [Crystal](https://crystal-lang.org). In order to build
from source you must have the [Crystal compiler](https://crystal-lang.org/reference/installation).

- __Clone the repository:__

```sh
$ clone https://github.com/caian-org/coin
```

- __Make and install:__

```sh
$ make
$ chmod +x coin
$ (sudo) mv coin /usr/bin
```

### Running on Docker

- __Pull from DockerHub:__

```sh
$ docker pull caian/coin
```

- __Run the container:__

```sh
$ docker run -e FIXER_API_TOKEN="my_token" caian/coin 1 usd jpy
```

Alternatively, you can build the Docker image yourself:

```sh
docker build -t coin .
```

## Contributing

Contributions are welcomed. You can contribute with bugfixes and minor
features. For bigger, more complex features or architectural changes, please
contact me beforehand.

If you wish to contribute:

- Fork it (https://github.com/caian-org/coin/fork)
- Create your feature branch (`git checkout -b my-new-feature`)
- Commit your changes (`git commit -am 'Add some feature'`)
- Push to the branch (`git push origin my-new-feature`)
- Create a new Pull Request

Large contributions must contain a notice stating that the owner (i.e., the
contributor) waive it's copyrights to the Public Domain.

## License

To the extent possible under law, [Caian Ertl][me] has waived __all copyright
and related or neighboring rights to this work__. In the spirit of _freedom of
information_, I encourage you to fork, modify, change, share, or do whatever
you like with this project! [`^C ^V`][kopimi]

[![License][cc-shield]][cc-url]

[me]: https://github.com/upsetbit
[cc-shield]: https://forthebadge.com/images/badges/cc-0.svg
[cc-url]: http://creativecommons.org/publicdomain/zero/1.0

[kopimi]: https://kopimi.com