Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/aorumbayev/tinybar

๐Ÿ”ฎ MacOS menu bar app to see prices of ASA pairs from Tinyman.org ๐Ÿ‘€
https://github.com/aorumbayev/tinybar

algorand algorand-standard-assets awesome-algorand macos macos-menubar python rumps tinyman

Last synced: 3 months ago
JSON representation

๐Ÿ”ฎ MacOS menu bar app to see prices of ASA pairs from Tinyman.org ๐Ÿ‘€

Awesome Lists containing this project

README

        

687474703a2f2f6936332e74696e797069632e636f6d2f333031336c67342e706e67


Frontend
Frontend


Frontend





## ๐Ÿ“ƒ About

A simple MacOS menu bar app to display current coins from most popular Liquidity Pools on [TinyMan.org](https://tinyman.org/) ๐Ÿค–

![Alt Text](https://media0.giphy.com/media/AuM0IkgPk8JnzBiDyM/giphy.gif?cid=790b761191e349aa088248e8fdad6edfd657e1471ed5bd49&rid=giphy.gif&ct=g)

_**โš ๏ธ NOTE: This is a pre-release version, utility is under active development.**_

---

## Prerequisites

- [python 3.9.x](https://www.python.org/)
- [poetry](https://python-poetry.org/)
- [pre-commit](https://pre-commit.com/)

## ๐Ÿš€ Quick start

If you are looking for quick executable installation refer to links below:

- [MacOS latest](https://github.com/aorumbayev/tinybar/releases/)

Afterwards, you can download latest `TinyBar.zip` file and move `*.app` file to `Applications` folder.

> Currently available on M1 Macs via Rosseta only.
> Additionally, note that the .app artifact is not signed, you need to navigate to `System Preferences` -> `Security & Privacy` -> `Click lock to make changes` -> allow `TinyBar.app` to run.

### Features

Be aware that by default the tool displays a `USDC` equivalent of `ALGO` after performing a swap between 1 `UNIT` of selected `ASA` and `ALGO`.

- โœ… - 5 Pairs available by default. _(Available)_
- โœ… - Add any Asset by ASA ID. _(Available)_
- โš ๏ธ - CI/CD _(Partially configured)_
- ๐Ÿšง - Custom base currency. _(only ALGO at the moment)_
- ๐Ÿšง - Code signed MacOS executables _(TBD)_

## โš™๏ธ Installation

_(for devs/contributors only )_

This section assumes that `poetry` and `pre-commit` are installed and executed from the root folder of this repository.

1. Clone the repo

```bash
git clone https://github.com/aorumbayev/tinybar
```

2. Install `python` requirements

```bash
poetry install # install all dependencies
poetry shell # activate virtual env
```

3. Configure `pre-commit` hooks

```bash
pre-commit install
```

4. Run tinybar in dev mode

```bash
(.venv) PYTHONPATH="." python src/tinybar.py
```

5. (optional) Build app executable

```bash
(.venv) PYTHONPATH="." python3 setup.py py2app
```

## ๐Ÿงช Testing

TBD

## ๐Ÿ™‹โ€โ™‚๏ธ Contribution guideline

TBD

## โญ๏ธ Stargazers

Special thanks to everyone who forked or starred the repository โค๏ธ

[![Stargazers repo roster for @aorumbayev/tinybar](https://reporoster.com/stars/dark/aorumbayev/tinybar)](https://github.com/aorumbayev/tinybar/stargazers)

[![Forkers repo roster for @aorumbayev/tinybar](https://reporoster.com/forks/dark/aorumbayev/tinybar)](https://github.com/aorumbayev/tinybar/network/members)