Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deanishe/alfred-convert
Convert between different units in Alfred
https://github.com/deanishe/alfred-convert
alfred alfred-workflow alfred3 alfred4 alfred4-workflow conversion cryptocurrencies currencies exchange-rates offline pint python
Last synced: about 1 month ago
JSON representation
Convert between different units in Alfred
- Host: GitHub
- URL: https://github.com/deanishe/alfred-convert
- Owner: deanishe
- License: other
- Created: 2014-02-24T18:38:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-08T11:05:30.000Z (about 2 years ago)
- Last Synced: 2024-06-21T18:44:46.364Z (3 months ago)
- Topics: alfred, alfred-workflow, alfred3, alfred4, alfred4-workflow, conversion, cryptocurrencies, currencies, exchange-rates, offline, pint, python
- Language: Python
- Homepage:
- Size: 5.08 MB
- Stars: 720
- Watchers: 13
- Forks: 56
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- alfred-workflows - Convert - Convert between different units. (Utility)
README
Alfred-Convert
==============
Convert between different units offline in [Alfred 3 & 4][alfred].
![][demo]
Alfred-Convert uses a [built-in library][pintdocs] for lightning-fast conversions.
You can also add your own custom units.
**Note:** Currency conversions do require occasional Internet connectivity to update exchange rates. Alfred-Convert will otherwise work just fine without an Internet connection.
- [Downloading](#downloading)
- [Usage](#usage)
- [Conversions](#conversions)
- [Configuration](#configuration)
- [Configuration sheet](#configuration-sheet)
- [Active currencies](#active-currencies)
- [Custom units](#custom-units)
- [Supported units](#supported-units)
- [Supported currencies](#supported-currencies)
- [Adding custom units](#adding-custom-units)
- [Releases](#releases)
- [Thanks, copyright, licensing](#thanks-copyright-licensing)
Download from [GitHub releases][ghreleases].
**Note**: Version 3.7 and above only supports Alfred 4+. If you're still using Alfred 3, please download [v3.6.2][v3.6.2].
- `conv []` — Perform a conversion
- `↩` — Copy result without thousands separator to pasteboard
- `⌘C` — Copy result with thousands separator to pasteboard
- `⌘↩` — Add/remove destination unit as default for this dimensionality
- `⌘L` — Show result in Alfred's Large Type window
- `convinfo` — View help file and information about the workflow, or edit custom units and active currencies
- `View Help File` — Open this page in your browser
- `View All Supported Currencies` — View/filter the list of all supported currencies in Alfred
- `Edit Active Currencies` — Edit the list of active currencies in your default text editor
- `Edit Custom Units` — Edit the list of custom currencies in your default text editor
**NOTE**: Only a limited number of fiat currencies are supported by default. Additional rates are only supported if you set a key for the [openexchangerates.org][openx] API in the workflow's [configuration sheet](#configuration). You can sign up for a free account [here][openx-free]. When you're signed up, copy the **App ID** from the email you receive or [this page][openx-appid] into the `APP_KEY` field in the [configuration sheet](#configuration).
- `conv [] []` — Perform a conversion
- `↩` or `⌘C` — Copy the result to the pasteboard
- `⌘↩` — Add/remove destination unit as default for this dimensionality
- `⌘L` — Show result in Alfred's Large Type window
If no destination unit is specified, any defaults you've saved will be used (that aren't the same as the source unit).
The syntax is simple: an optional context, the quantity, the unit you want to convert from then (optionally) the unit you want to convert to. For example:
- `conv 128 mph kph`
- `conv 72in cm`
- `conv 100psi bar`
- `conv 20.5 m/s mph`
- `conv 100 eur gbp`
Or with a context:
- `conv spectroscopy 1Å eV` (or `conv sp 1Å eV`)
It doesn't matter if there is a space between the quantity and the units or not. Alfred-Convert will tell you if it doesn't understand your query or know the units.
Actioning an item (selecting it and hitting `↩`) will copy it to the clipboard. Using `⌘+L` will display the result in Alfred's large text window, `⌘+C` will copy the selected result to the clipboard.
The workflow is configured via the [configuration sheet][config-sheet] (the `[𝒙]` icon) in Alfred Preferences and via a couple of text files in its data directory.
#### Configuration sheet ####
Basic configuration is performed in the [configuration sheet][config-sheet]:
| Option | Meaning |
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `APP_KEY` | API key for [openexchangerates.org][openx]. |
| `COPY_UNIT` | Include unit when copying conversion result. Any value but `0` or empty turns this option on. |
| `CURRENCY_DECIMAL_PLACES` | Overrides the default `DECIMAL_PLACES` setting for currency conversions. |
| `DECIMAL_PLACES` | Number of decimal places to show in results. |
| `DECIMAL_SEPARATOR` | Character to separate whole numbers and decimal fractions. Used for parsing input and generating output. |
| `DYNAMIC_DECIMALS` | Dynamically increase the number of decimal places (up to 10) so that the result is non-zero. Any value but `0` or empty turns this option on. |
| `THOUSANDS_SEPARATOR` | Character to delimit thousands Used for parsing input and generating output. |
| `UPDATE_INTERVAL` | How often (in minutes) to update currency exchange rates. |
#### Active currencies ####
By default, all supported fiat currencies (provided you've set `APP_KEY` in the [configuration sheet](#configuration)) and a handful of the most popular cryptocurrencies are active.
- `convinfo`
- `View All Supported Currencies`
- `Edit Active Currencies`
Use `Edit Active Currencies` to open the list of active currencies in your default editor. Add the symbol for the currency you'd like to activate on a new line in this file.
You can use `View All Supported Currencies` to search for the currency you'd like to activate, then use `⌘C` on the result to copy the symbol to the pasteboard.
#### Custom units ####
See [Adding custom units](#adding-custom-units).
Supported units
---------------
Currently, Alfred-Convert only supports [the units][pintunits] understood by the underlying [Pint][pintdocs] library plus [currencies](#supported-currencies) and a handful of additional units.
You can [add your own custom units](#adding-custom-units) to the workflow. If you think they'd be useful to everyone, please create a corresponding [GitHub issue][ghissues] to request addition as a default unit or submit a [pull request][ghpulls].
To convert, use the appropriate **abbreviation** for the relevant currencies, e.g. `conv 100 eur gbp`.
You can also view (and search) the list from within Alfred by using the keyword `convinfo` and choosing `View All Supported Currencies`.
[All supported currencies](./docs/currencies.md).
You can add your own custom units using the [format defined by Pint][pinthowto]. Add your definitions to the `unit_definitions.txt` file in the workflow's data directory.
To edit this file, enter `convinfo` in Alfred and select `Edit Custom Units`. The `unit_definitions.txt` file will open in your default text editor.
Please see the [Pint documentation][pinthowto] for the required format. See Pint's [default unit definitions][pintunits] for examples.
See [CHANGELOG][changelog] for more information.
| Release | Date |
|-----------------|----------------|
| [3.7.0][v3.7.0] | 2020-02-20 |
| [3.6.2][v3.6.2] | 2019-09-06 |
| [3.6.1][v3.6.1] | 2019-05-30 |
| [3.6.0][v3.6.0] | 2019-05-06 |
| [3.5.3][v3.5.3] | 2019-01-26 |
| [3.5.2][v3.5.2] | 2019-01-26 |
| [3.5.1][v3.5.1] | 2018-01-13 |
| [3.5][v3.5] | 2018-01-12 |
| [3.4][v3.4] | 2017-12-26 |
| [3.3.1][v3.3.1] | 2017-11-21 |
| [3.3][v3.3] | 2017-11-20 |
| [3.2.2][v3.2.2] | 2017-11-07 |
| [3.2.1][v3.2.1] | 2017-11-04 |
| [3.2][v3.2] | 2017-11-02 |
| [3.1][v3.1] | 2017-11-02 |
| [3.0][v3.0] | 2017-07-16 |
| [2.6][v2.6] | 2017-06-15 |
| [2.5][v2.5] | 2015-12-11 |
| [2.4][v2.4] | 2015-11-28 |
| [2.3][v2.3] | 2015-11-26 |
| [2.2][v2.2] | 2015-07-16 |
| 2.1 | Never released |
| [2.0][v2.0] | 2014-12-26 |
| [1.2][v1.2] | 2014-08-19 |
| [1.1][v1.1] | 2014-08-09 |
Thanks, copyright, licensing
----------------------------
- The Python [Pint][pintdocs] library does all the heavy lifting. See the [Pint GitHub repo][pintrepo] for Pint licensing or `LICENSE.txt` and `AUTHORS.txt` in the `pint` subdirectory.
- The workflow icons are from [Font Awesome][fontawesome]
- Exchange rates are downloaded from [openexchangerates.org][openx] and [CryptoCompare][cryptocompare] (for cryptocurrencies).
- The [Alfred-Workflow][alfred-workflow] library is used heavily.
All other code/media are released under the [MIT Licence][mit].
[alfred-workflow]: http://www.deanishe.net/alfred-workflow/
[alfred]: http://www.alfredapp.com/
[changelog]: ./CHANGELOG.md
[demo]: https://raw.github.com/deanishe/alfred-convert/master/demo.gif
[fontawesome]: http://fortawesome.github.io/Font-Awesome/
[ghissues]: https://github.com/deanishe/alfred-convert/issues
[ghpulls]: https://github.com/deanishe/alfred-convert/pulls
[ghreleases]: https://github.com/deanishe/alfred-convert/releases
[mit]: http://opensource.org/licenses/MIT
[pintdocs]: http://pint.readthedocs.org/en/latest/index.html
[pinthowto]: http://pint.readthedocs.org/en/latest/defining.html
[pintrepo]: https://github.com/hgrecco/pint
[pintunits]: https://github.com/hgrecco/pint/blob/master/pint/default_en.txt
[v1.1]: https://github.com/deanishe/alfred-convert/releases/tag/v1.1
[v1.2]: https://github.com/deanishe/alfred-convert/releases/tag/v1.2
[v2.0]: https://github.com/deanishe/alfred-convert/releases/tag/v2.0
[v2.2.1]: https://github.com/deanishe/alfred-convert/releases/tag/v2.2.1
[v2.2]: https://github.com/deanishe/alfred-convert/releases/tag/v2.2
[v2.3]: https://github.com/deanishe/alfred-convert/releases/tag/v2.3
[v2.4]: https://github.com/deanishe/alfred-convert/releases/tag/v2.4
[v2.5]: https://github.com/deanishe/alfred-convert/releases/tag/v2.5
[v2.6]: https://github.com/deanishe/alfred-convert/releases/tag/v2.6
[v3.0]: https://github.com/deanishe/alfred-convert/releases/tag/v3.0
[v3.1]: https://github.com/deanishe/alfred-convert/releases/tag/v3.1
[v3.2]: https://github.com/deanishe/alfred-convert/releases/tag/v3.2
[v3.2.1]: https://github.com/deanishe/alfred-convert/releases/tag/v3.2.1
[v3.2.2]: https://github.com/deanishe/alfred-convert/releases/tag/v3.2.2
[v3.3]: https://github.com/deanishe/alfred-convert/releases/tag/v3.3
[v3.3.1]: https://github.com/deanishe/alfred-convert/releases/tag/v3.3.1
[v3.4]: https://github.com/deanishe/alfred-convert/releases/tag/v3.4
[v3.5]: https://github.com/deanishe/alfred-convert/releases/tag/v3.5
[v3.5.1]: https://github.com/deanishe/alfred-convert/releases/tag/v3.5.1
[v3.5.2]: https://github.com/deanishe/alfred-convert/releases/tag/v3.5.2
[v3.5.3]: https://github.com/deanishe/alfred-convert/releases/tag/v3.5.3
[v3.6.0]: https://github.com/deanishe/alfred-convert/releases/tag/v3.6.0
[v3.6.1]: https://github.com/deanishe/alfred-convert/releases/tag/v3.6.1
[v3.6.2]: https://github.com/deanishe/alfred-convert/releases/tag/v3.6.2
[v3.7.0]: https://github.com/deanishe/alfred-convert/releases/tag/v3.7.0
[cryptocompare]: https://www.cryptocompare.com/
[openx]: https://openexchangerates.org/
[openx-free]: https://openexchangerates.org/signup/free
[openx-appid]: https://openexchangerates.org/account/app-ids
[config-sheet]: https://www.alfredapp.com/help/workflows/advanced/variables/#environment