-
Notifications
You must be signed in to change notification settings - Fork 0
/
setup.py
134 lines (88 loc) · 3.98 KB
/
setup.py
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
from setuptools import setup, find_packages
setup(
name='ryzen-master-commander',
version='0.1.7',
packages=find_packages(),
install_requires=[
'matplotlib',
'ttkbootstrap',
],
entry_points={
'console_scripts': [
'ryzen-master-commander = app:main',
],
},
long_description="""# Ryzen Master & Commander 🚀
Ryzen Master & Commander is a Python-based GUI application for monitoring and controlling Ryzen-based systems, with a focus on the GPD Win Mini. It provides features such as temperature and fan speed monitoring, fan control, and TDP (Thermal Design Power) settings management. 🌡️💨🔧
![Main UI](img/main_ui.png)
*The main user interface of Ryzen Master Commander*
## Features ✨
- Real-time temperature and fan speed monitoring with graphs 📈
- Manual and automatic fan speed control 🌬️
- TDP settings management with customizable profiles ⚙️
- User-friendly GUI built with ttkbootstrap 🎨
Here's a Quick Start guide that you can add to your README.md file:
## Quick Start 🚀
To get started with Ryzen Master Commander quickly, follow these steps:
### Prerequisites
Make sure you have the following dependencies installed on your system:
- Python 3.6 or higher 🐍
- TCL and Tk libraries 🖼️
- `nbfc-linux` and `ryzenadj` command-line tools 🔧 from the following projects:
- https://github.com/nbfc-linux/nbfc-linux
- https://github.com/FlyGoat/RyzenAdj
#### Installing Dependencies on Arch Linux
```
sudo pacman -S python tcl tk nbfc ryzenadj
```
#### Installing Dependencies on Debian-based Systems (Ubuntu, Debian, etc.)
Install tkinter: `sudo apt install python3-tk`
Follow the instructions for your linux distribution on the respective project package page above to install nbfc-linux and ryzenadj.
### Installation
Install Ryzen Master Commander using pip:
```
pip install ryzen-master-commander
```
### Running the Application
Launch Ryzen Master Commander by running the following command:
```
ryzen-master-commander
```
The application will prompt you for your sudo password, which is required for controlling the fan speed and applying TDP settings. 🔑
That's it! You're now ready to use Ryzen Master Commander to monitor and control your Ryzen-based system. Enjoy! 😊
### Installing from Source
To install Ryzen Master Commander from source, follow these steps:
1. Clone the repository:
```
git clone https://github.com/sam1am/Ryzen-Master-Commander.git
```
2. Navigate to the project directory:
```
cd Ryzen-Master-Commander
```
3. Install the required Python packages:
```
pip install -e .
```
This command installs the package in editable mode, allowing you to make changes to the source code and have them immediately reflected in the installed package. 🎉
## Usage 🚀
To launch Ryzen Master Commander, run the following command:
```
ryzen-master-commander
```
The application will prompt you for your sudo password, which is required for controlling the fan speed and applying TDP settings. 🔑
## Screenshots 📷
![Profile Saver](img/profile_saver.png)
*Saving a custom TDP profile*
![UI with Graph](img/ui_w_graph.png)
*Real-time temperature and fan speed monitoring with graphs*
## Contributing 🤝
Contributions to Ryzen Master Commander are welcome! If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request on the [GitHub repository](https://github.com/yourusername/Ryzen-Master-Commander). 😊
## License 📜
This project is licensed under the [Apache License 2.0](LICENSE).
## Acknowledgements 🙏
Ryzen Master Commander was developed on Arch Linux for the GPD Win Mini, but it should work on other Ryzen-based devices as well. Special thanks to the developers of the `nbfc-linux` and `ryzenadj` tools, which make this application possible. 👏
""",
long_description_content_type="text/markdown",
description='A GUI application for monitoring and controlling fan and tdp settings on Ryzen-based systems.',
)