Skip to content

Commit 2c7ae53

Browse files
committed
- version 0.8.9.15
- finalizing things - updating docs
1 parent aff1d70 commit 2c7ae53

15 files changed

+373
-238
lines changed

Changelog

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
2022-03-10 s-n-g
1+
2022-03-15 s-n-g
2+
* version 0.8.9.15 (0.9-beta12)
3+
* fixing "0" and "$" insertion on RadioBrowser search window
4+
* macOS installation method updated to pip
5+
* fixing a macOS RadioBrowser interface breakage
26
* Windows installation method updated to pip
37
* adding F7, F8, F9, F10 functionality for Windows
4-
* fixing MacOS layout breakage on RadioBrowser
58
* updating docs
69

710
2022-02-14 s-n-g
@@ -491,7 +494,7 @@
491494
* '/' win no longer display help ('?' is still valid)
492495
* minor errors fixed
493496
* error_code renamed to operation_mode
494-
* build script working on MacOS
497+
* build script working on macOS
495498

496499
2018-12-02 s-n-g
497500

README.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,14 @@ <h2 id="features">Features <span style="padding-left: 10px;"><sup style="font-si
126126
<li>Theming support</li>
127127
<li><a href="radio-browser.html">RadioBrowser</a> support</li>
128128
<li>Easy installation / updating</li>
129-
<li>Runs on Linux, MacOS and Windows</li>
129+
<li>Runs on Linux, macOS and Windows</li>
130130
</ul>
131131
<p>and much more…</p>
132132
<h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
133133
<ul>
134134
<li>python 2.7/3.5+
135135
<ul>
136+
<li>wheel</li>
136137
<li>requests</li>
137138
<li>dnspython</li>
138139
<li>psutil</li>
@@ -143,10 +144,13 @@ <h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style=
143144
<h2 id="changelog">Changelog <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
144145
<pre style="height: 200px;">
145146

146-
2022-03-10 s-n-g
147+
2022-03-15 s-n-g
148+
* version 0.8.9.15 (0.9-beta12)
149+
* fixing "0" and "$" insertion on RadioBrowser search window
150+
* macOS installation method updated to pip
151+
* fixing a macOS RadioBrowser interface breakage
147152
* Windows installation method updated to pip
148153
* adding F7, F8, F9, F10 functionality for Windows
149-
* fixing MacOS layout breakage on RadioBrowser
150154
* updating docs
151155

152156
2022-02-14 s-n-g
@@ -636,7 +640,7 @@ <h2 id="changelog">Changelog <span style="padding-left: 10px;"><sup style="font-
636640
* '/' win no longer display help ('?' is still valid)
637641
* minor errors fixed
638642
* error_code renamed to operation_mode
639-
* build script working on MacOS
643+
* build script working on macOS
640644

641645
2018-12-02 s-n-g
642646

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,13 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
7474
- Theming support
7575
- [RadioBrowser](radio-browser.md) support
7676
- Easy installation / updating
77-
- Runs on Linux, MacOS and Windows
77+
- Runs on Linux, macOS and Windows
7878

7979
and much more...
8080

8181
## Requirements
8282
* python 2.7/3.5+
83+
- wheel
8384
- requests
8485
- dnspython
8586
- psutil

build.html

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,41 @@ <h1 style="color: SaddleBrown"id="pyradio-build-instructions">PyRadio Build Inst
4141
<h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
4242
<!-- vim-markdown-toc Marked -->
4343
<ul>
44+
<li><a href="#current-state-of-the-project">Current state of the project</a>
45+
<ul>
46+
<li><a href="#what-does-it-all-mean-and-why-should-you-care">What does it all mean and why should you care</a></li>
47+
</ul></li>
4448
<li><a href="#preparing-for-the-installation">Preparing for the installation</a>
4549
<ul>
50+
<li><a href="#linux">Linux</a>
51+
<ul>
4652
<li><a href="#notice-for-python-2-users">Notice for Python 2 users</a></li>
47-
<li><a href="#linux">Linux</a></li>
53+
</ul></li>
4854
<li><a href="#macos">macOS</a></li>
4955
<li><a href="#windows">Windows</a></li>
5056
</ul></li>
51-
<li><a href="#performing-the-installation">Performing the installation</a>
57+
<li><a href="#performing-the-installation">Performing the installation</a> * <a href="#note-for-macos-users">Note for macOS users</a>
5258
<ul>
5359
<li><a href="#updating-a-pre-0.8.9-installation">Updating a pre 0.8.9 installation</a></li>
5460
</ul></li>
5561
</ul>
5662
<!-- vim-markdown-toc -->
5763
<p><a href="README.html">[Return to main doc]</a></p>
64+
<h2 id="current-state-of-the-project">Current state of the project <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
65+
<p>Starting with version <strong>0.8.9.15</strong>, <strong>PyRadio</strong> has changed its installation method from invoking <em>setup.py</em> directly to <em>pip</em> (i.e. from “<em>python setup.py install</em>” to “<em>python -m pip .</em>”). This is a must for all <strong>Python</strong> projects in order to keep up with the latest developments. For more info, please refer to “<a target="_blank" href="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html">Why you shouldn’t invoke setup.py directly</a>”.</p>
66+
<h3 id="what-does-it-all-mean-and-why-should-you-care">What does it all mean and why should you care</h3>
67+
<p>Moving to the <strong>pip</strong> way of doing things has its implications:</p>
68+
<ol type="1">
69+
<li><strong>PyRadio</strong> will be installed as a pip package.</p></li>
70+
<li><strong>PyRadio</strong> will no longer be installed as a system-wide package.<br />
71+
<br />
72+
This means that after installing <strong>PyRadio</strong>, it will only be available to the current user. If another user wants to use it as well, he would have to install it again.<br />
73+
<br />
74+
In other words, in order to have a <strong>Pyradio system-wide installation</strong>, your distribution has to provide a package for it.</p></li>
75+
<li>As I’m starting the procedure to move away from <em>Python 2</em>, <strong>PyRadio</strong> will not be compatible with it on <em>macOs</em> and <em>Windows</em> (but will still be on <em>Linux</em>, at least for the time being).</p></li>
76+
</ol>
5877
<h2 id="preparing-for-the-installation">Preparing for the installation <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></style></h2>
5978
<p>Before installing <strong>PyRadio</strong> you have to prepare your system, so that you end up with a working installation. The process depends on the OS you are on.</p>
60-
<h3 id="notice-for-python-2-users">Notice for Python 2 users</h3>
61-
<p>If you are still using <strong>Python 2</strong>, plase make sure “<strong>pip</strong>” is installed. Execute the following command to verify its existance:</p>
62-
<pre>python[2] -m pip list</pre>
63-
<p>If you get a response, you are good to go. Otherwise, use your distro package manager to install it.</p>
64-
<p>If your distro does not provide it (some do not anymore), use the following commands to get it:</p>
65-
<pre>curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py
66-
sudo python[2] get-pip.py</pre>
6779
<h3 id="linux">Linux</h3>
6880
<p>Use your distribution method to install</p>
6981
<ol type="1">
@@ -74,14 +86,21 @@ <h3 id="linux">Linux</h3>
7486
<li><em>sed</em></li>
7587
<li>any one of <em>MPV</em>, <em>MPlayer</em> and/or <em>VLC</em>.</li>
7688
</ol>
89+
<h4 id="notice-for-python-2-users">Notice for Python 2 users</h4>
90+
<p>If you are still using <strong>Python 2</strong>, plase make sure “<strong>pip</strong>” is installed. Execute the following command to verify its existance:</p>
91+
<pre>python[2] -m pip list</pre>
92+
<p>If you get a response, you are good to go. Otherwise, use your distro package manager to install it.</p>
93+
<p>If your distro does not provide it (some do not anymore), use the following commands to get it:</p>
94+
<pre>curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py
95+
sudo python[2] get-pip.py</pre>
7796
<p>When you are done, proceed to “<a href="#performing-the-installation">Performing the installation</a>”.</p>
7897
<h3 id="macos">macOS</h3>
7998
<p>First thing you do is install python dependencies (assuming python 3 is installed):</p>
8099
<pre>pip3 install --upgrade wheel requests dnspython psutil</pre>
81100
<p>Everything else you need to install and run <strong>pyradio</strong> is available on <a target="_blank" href="https://github.com/Homebrew/homebrew">Homebrew</a>. If you haven’t already downloaded its client, go ahead and do it.</p>
82101
<p>Open a <strong>terminal</strong> and type:</p>
83102
<pre>/usr/bin/ruby -e &quot;$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)&quot;</pre>
84-
<p>Depending on your Mac OS version, you may have to install <strong>sed</strong> too:</p>
103+
<p>Depending on your macOS version, you may have to install <strong>sed</strong> too:</p>
85104
<pre>brew install gnu-sed --default-names</pre>
86105
<p>Now it’s time to install a media player. You are free to install any one of them or even more than one…</p>
87106
<p>1. <strong><em>MPV</em></strong></p>
@@ -114,6 +133,12 @@ <h2 id="performing-the-installation">Performing the installation <span style="pa
114133
<pre>python3 install.py</pre>
115134
<p>If for some reason you want a <strong>python 2</strong> installation, execute:</p>
116135
<pre>python2 install.py</pre>
136+
<h4 id="note-for-macos-users">Note for macOS users</h4>
137+
<p>This release of <strong>PyRadio</strong> has been tested on <strong>Catalina</strong> and <strong>Big Sur</strong>.</p>
138+
<p>On <strong>Catalina</strong> the executable has been placed on a location which is not directly accessible (not in the PATH). <strong>PyRadio</strong> will try to link it to your <strong>bin</strong> folder (creating <em>~/bin/pyradio</em>), and <strong>PyRadio</strong> will be ready yo be executed, provided that this folder is in your PATH and that <strong>Homebrew</strong> default installation folders have been used during the installation of <strong>Python 3</strong>.</p>
139+
<p>In case a different <strong>Homebrew</strong> location has been used (or a different package manager, for this matter), you can just point the installation to the correct path, using the following command (post installation):</p>
140+
<pre>python3 install.py --brew /path/to/homebrew/installation</pre>
141+
<p>so that <strong>PyRadio</strong> can find and link the executable to your <strong>bin</strong> folder.</p>
117142
<h3 id="updating-a-pre-0.8.9-installation">Updating a pre 0.8.9 installation</h3>
118143
<p>If you are on a pre 0.8.9 release and want to update <strong>PyRadio</strong>, just follow the instructions above, but add the “<em>–force</em>” command line parameter to the installation command.</p>
119144
<p>So, instead of</p>

build.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,44 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
77
## Table of Contents
88
<!-- vim-markdown-toc Marked -->
99

10+
* [Current state of the project](#current-state-of-the-project)
11+
* [What does it all mean and why should you care](#what-does-it-all-mean-and-why-should-you-care)
1012
* [Preparing for the installation](#preparing-for-the-installation)
11-
* [Notice for Python 2 users](#notice-for-python-2-users)
1213
* [Linux](#linux)
14+
* [Notice for Python 2 users](#notice-for-python-2-users)
1315
* [macOS](#macos)
1416
* [Windows](#windows)
1517
* [Performing the installation](#performing-the-installation)
18+
* [Note for macOS users](#note-for-macos-users)
1619
* [Updating a pre 0.8.9 installation](#updating-a-pre-0.8.9-installation)
1720

1821
<!-- vim-markdown-toc -->
1922

2023
[[Return to main doc]](README.md)
2124

25+
## Current state of the project
2226

23-
## Preparing for the installation
27+
Starting with version **0.8.9.15**, **PyRadio** has changed its installation method from invoking *setup.py* directly to *pip* (i.e. from "*python setup.py install*" to "*python -m pip .*"). This is a must for all **Python** projects in order to keep up with the latest developments. For more info, please refer to "[Why you shouldn't invoke setup.py directly](https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html)".
2428

25-
Before installing **PyRadio** you have to prepare your system, so that you end up with a working installation. The process depends on the OS you are on.
29+
### What does it all mean and why should you care
2630

27-
### Notice for Python 2 users
31+
Moving to the **pip** way of doing things has its implications:
2832

29-
If you are still using **Python 2**, plase make sure "**pip**" is installed. Execute the following command to verify its existance:
33+
1. **PyRadio** will be installed as a pip package.
3034

31-
python[2] -m pip list
35+
2. **PyRadio** will no longer be installed as a system-wide package. \
36+
\
37+
This means that after installing **PyRadio**, it will only be available to the current user. If another user wants to use it as well, he would have to install it again. \
38+
\
39+
In other words, in order to have a **Pyradio system-wide installation**, your distribution has to provide a package for it.
3240

33-
If you get a response, you are good to go. Otherwise, use your distro package manager to install it.
41+
3. As I'm starting the procedure to move away from *Python 2*, **PyRadio** will not be compatible with it on *macOs* and *Windows* (but will still be on *Linux*, at least for the time being).
3442

35-
If your distro does not provide it (some do not anymore), use the following commands to get it:
3643

37-
curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py
38-
sudo python[2] get-pip.py
44+
## Preparing for the installation
45+
46+
Before installing **PyRadio** you have to prepare your system, so that you end up with a working installation. The process depends on the OS you are on.
47+
3948

4049
### Linux
4150

@@ -48,6 +57,19 @@ Use your distribution method to install
4857
5. *sed*
4958
6. any one of *MPV*, *MPlayer* and/or *VLC*.
5059

60+
#### Notice for Python 2 users
61+
62+
If you are still using **Python 2**, plase make sure "**pip**" is installed. Execute the following command to verify its existance:
63+
64+
python[2] -m pip list
65+
66+
If you get a response, you are good to go. Otherwise, use your distro package manager to install it.
67+
68+
If your distro does not provide it (some do not anymore), use the following commands to get it:
69+
70+
curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py
71+
sudo python[2] get-pip.py
72+
5173
When you are done, proceed to "[Performing the installation](#performing-the-installation)".
5274

5375

@@ -63,7 +85,7 @@ Open a **terminal** and type:
6385

6486
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
6587

66-
Depending on your Mac OS version, you may have to install **sed** too:
88+
Depending on your macOS version, you may have to install **sed** too:
6789

6890
brew install gnu-sed --default-names
6991

@@ -126,6 +148,19 @@ If for some reason you want a **python 2** installation, execute:
126148

127149
python2 install.py
128150

151+
152+
#### Note for macOS users
153+
154+
This release of **PyRadio** has been tested on **Catalina** and **Big Sur**.
155+
156+
On **Catalina** the executable has been placed on a location which is not directly accessible (not in the PATH). **PyRadio** will try to link it to your **bin** folder (creating *~/bin/pyradio*), and **PyRadio** will be ready yo be executed, provided that this folder is in your PATH and that **Homebrew** default installation folders have been used during the installation of **Python 3**.
157+
158+
In case a different **Homebrew** location has been used (or a different package manager, for this matter), you can just point the installation to the correct path, using the following command (post installation):
159+
160+
python3 install.py --brew /path/to/homebrew/installation
161+
162+
so that **PyRadio** can find and link the executable to your **bin** folder.
163+
129164
### Updating a pre 0.8.9 installation
130165

131166
If you are on a pre 0.8.9 release and want to update **PyRadio**, just follow the instructions above, but add the "*--force*" command line parameter to the installation command.

0 commit comments

Comments
 (0)