61 lines
1.2 KiB
ReStructuredText
61 lines
1.2 KiB
ReStructuredText
==============
|
|
PyWMCurrencies
|
|
==============
|
|
|
|
WindowMaker dockapp for getting average exchange rates for Polish Złoty using
|
|
NBP official data using their API.
|
|
|
|
|
|
Requirements
|
|
============
|
|
|
|
* Python
|
|
* wmdocklib
|
|
* requests
|
|
|
|
Note, that you'll need to install `this wmdocklib`_ instead of original
|
|
`pywmdockapps`_, since the latter works only with Python2.
|
|
|
|
|
|
Installation
|
|
============
|
|
|
|
For now, use virtualenv:
|
|
|
|
.. code:: shell-session
|
|
|
|
$ python -m virtualenv venv
|
|
$ . venv/bin/activate
|
|
(venv) $ pip install .
|
|
|
|
|
|
Usage
|
|
=====
|
|
|
|
You'll need to prepare yaml file with the configuration. And put it in
|
|
``~/.config/pywmcurrencies.yaml`` (or whatever your XDG_CONFIG_HOME points to).
|
|
For example:
|
|
|
|
.. code:: yaml
|
|
|
|
---
|
|
currencies:
|
|
- eur
|
|
- usd
|
|
|
|
Here we have two currencies (alpha codes for currencies as in `ISO 4217`_
|
|
standard), which will be monitored. Note, that currencies are fetched at the
|
|
app start, and than every hour, just to not hammer the NBP servers.
|
|
|
|
|
|
License
|
|
=======
|
|
|
|
This software is licensed under 3-clause BSD license. See LICENSE file for
|
|
details.
|
|
|
|
|
|
.. _this wmdocklib: https://github.com/gryf/wmdocklib
|
|
.. _pywmdockapps: https://github.com/mfrasca/pywmdockapps
|
|
.. _ISO 4217: https://en.wikipedia.org/wiki/ISO_4217
|