wolfrust / bannoti Goto Github PK

                     ____                          _   _
                     | __ )  __ _ _ __  _ __   ___ | |_(_)
                     |  _ \ / _` | '_ \| '_ \ / _ \| __| |
                     | |_) | (_| | | | | | | | (_) | |_| |
                     |____/ \__,_|_| |_|_| |_|\___/ \__|_|

                                        Desktop notification tool for banano (https://banano.cc)
                                         by Neptune (https://github.com/wolfrust)

✨You can use Bannoti to receive notifications for Banano transactions on your computer.

For everything below, replace bannoti.py with the file in your tree. (bannoti.exe on windows and bannoti on Linux)

Using already compiled executables is the recommended option, as you will simply have to run the executable without installing any programming languages. However, if you'd like to use the source code, that is documented as well below.

1. Grab the latest release.
2. Unzip the file you just downloaded
3. Open a terminal window
4. Move into the directory in which you placed the files
5. Run bannoti.py --yesstartup to add Bannoti to startup

Step 5 is optional but recommended, because otherwise you will have to start Bannoti manually every time you log on, which could get annoying.

Installing through source is a bit more gritty, but not very hard.

1. Install Rust and Python (3).
2. Download Bannoti's source code.
3. Unzip the file you just downloaded.
4. Open a terminal window.
5. Move into the directory of the files.
6. Run pip install -r config/requirements.txt to install required python modules.
7. Move into assets/notify/
8. Run cargo build --release. This will build the binary.
9. Run mv target/debug/notify .. (Linux) or move target\debug\notify.exe .. (Windows)
10. Move back into the root of the project : cd ../../
11. Delete the assets/notify/ directory : rm -rf assets/notify/. Make sure you type this out carefully, because you don't want to end up deleting the binary you just made.

At this point you can do two things.

1. Start using Bannoti without compiling bannoti.py : Run python bannoti.py --yesstartup, and you're ready.
2. Compile bannoti.py as well. Please refer to this guide if you do not know how to compile python files.

Running bannoti.py --help will show you a nice help message.

$> bannoti.py --help


  -- snip --


    bannoti.py <option>

    run : run the program
    --add : add an address to get notified for
    --remove : stop getting notifications for an address
    --gettracked : get tracked accounts
    --yesstartup : add program to startup (windows only)
    --nostartup : remove program from startup (windows only)


    If this is your first time using Bannoti, I recommend you see the README (docs/README.md).

It's pretty straightforward. You don't have to supply any other arguments, just one of these.

For example : $> bannoti.py --add

It would be rather tedious to have to reconfigure settings every time a new version of Bannoti is released. Fortunately, all you have to do is copy over the track.ini file to the new assets/ directory.

For example, from bannoti-v1.1/assets/track.ini to bannoti-v1.2/assets/track.ini.

Bannoti follows semantic versioning, meaning:

• v1.0.0 -> v1.0.1 : copy over track.ini
• v1.0 -> v1.1 : copy over track.ini
• v1 -> v2 : welp got to set it up from scratch

A small tip would go a long way :).

Banano 🍌 : ban_1378hqogtx33j1inek3j97rng1qpr457iucmcetqmioqj1335cm8ea9iiunf

Nano 🍂 : nano_1rhj7y5hkm5sx5rcn3p5tgsgyij1qwty1ja66197yacw3sjwoob3yyc76jbt

If you'd like to tip me via some other means, please contact me.

Bannoti is free of any malware and bloatware. I provide binary packages to make things easier for you, but if you'd rather install through the source code, that's documented as well. You can look at the source code yourself to verify that nothing's sus. So I think it's reasonable to conclude that your computer is safe.

Bannoti cannot access your wallet. It relies on public information to do it's thing. This means your funds are safe.

Bannoti respects your privacy. It doesn't ask for any confidential information, just addresses. They are stored offline in assets/track.ini on your computer.

Please note that some antivirus programs throw false positives on scanning Bannoti. This happens with all programs made using pyinstaller, which is a highly reputed compiler for python. If you take a look at this virustotal scan, you'll find that only 9/63 antivirus programs classify Bannoti as malware. If you head into the section on behaviour, you can see that the excecutable does nothing fishy.

Bannoti is licensed under the BSD 3-Clause "New" or "Revised" License. You can find it here. A short summary is given below.

The tool that sends the notifications is called notify-rust, and is distributed under this license.

The tool that allows python to interact with the Banano API is bananopy, and is distributed under this license. It is Copyright (c) 2020 milkyklim.

Please use the issues tab for this, as that provides me with an organized way to look at requests & reports. For bug reports, please attach the bug label, and for feature requests please attach the enhancment label.

This project would not have been possible without bananopy by @milkyklim, and notify-rust by @hoodie.

You can email me at [email protected].