-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Matrix_Crypto_Display_Info.txt
94 lines (64 loc) · 3.95 KB
/
Matrix_Crypto_Display_Info.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
Matrix Crypto Display
=================================
------------
Description:
------------
This application displays real-time cryptocurrency prices in a matrix-style animation within the terminal. It fetches current prices from the CoinGecko API and presents them in a visually appealing, continuously scrolling format. Api updates every 90 seconds
Windows and Linux Terminal using Python 3.8+
-----------
Quick start
-----------
Windows
run_windows.bat
Linux/MacOS
chmod +x run_linux.sh
./run_linux.sh
if you have trouble running then run sed -i 's/\r$//' ./run_linux.sh
and try again ./run_linux.sh
----------
Manual
----------
run pip install -r requirements.txt
or on Linux just run pip install request
or on windows run pip install windows-curses requests
---------
Usage
---------
python matrix_crypto.py
-----------
How to Use:
-----------
1. Use the prefilled crypto_list.json or modify and add your own tickers
(optional) You can run any of the .py files to get current list of Solana or Ethereum top 20 to populate the .json config
which is to get token id's and names for prices. Only really need to run once in awhile if what a fresh list. I would remove stable coins like USDC and USDT
python crypto_list.py = gets top 20 overall cryptos by marketcap (default list of cryptos)
python solana_crypto_list.py = gets top 20 solana tokens by marketcap
python ethereum_crypto_list.py = gets top 20 ethereum tokens by marketcap
2. Start the application by running: python matrix_crypto.py or if needed python3 matrix_crypto.py
3. Command-line Options
- --bg-color: Adjust the color of the falling background text (e.g., green, red, blue).
- --crypto-color: Choose the color of the crypto tickers (e.g., white, yellow, cyan).
---------
Log File:
---------
The application generates a log file (matrix_crypto.log) to store runtime information, errors, and other log messages. The log is rotated every 10 days to prevent excessive file size.
------------------------
Exiting the Application:
------------------------
TO EXIT THE APPLICATION, PRESS CTRL+C AT ANY TIME.
----------------------
Setup and Start script
----------------------
When you run the setup script (run_linux.sh for Unix-like systems or run_windows.bat for Windows), it automatically creates and activates a Python virtual environment in your project directory.
The script will install all necessary packages listed in requirements.txt into this environment, making it easy to manage project-specific dependencies and maintain a clean development setup.
For subsequent uses, you can activate the virtual environment manually with source venv/bin/activate (Unix-like systems) or .\venv\Scripts\activate (Windows) to run the project or additional Python commands.
--------------------
License Information:
--------------------
Matrix Crypto Display
Copyright (c) bigsk1 2024
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
If you enjoy using please support my work, thanks @bigsk1_com
BTC Tips: bc1qeyzfq7qvmpmye0j9jrg5zys2vle36gm37ln8j04ahv6q9ymp8awq4ee0td