Skip to content

Commit e0ad0a5

Browse files
committed
- updating setup.py and pyproject.toml for latest installayion method
- moving man pages to docs - updating docs
1 parent a37b2ac commit e0ad0a5

File tree

12 files changed

+1593
-13
lines changed

12 files changed

+1593
-13
lines changed

LICENCE renamed to LICENSE

File renamed without changes.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ If you face this situation, please refer to [this page](docs/pip-error.md) to re
2727

2828
<!-- vim-markdown-toc -->
2929

30+
* Please follow this link for the [Detailed documentation](docs/index.md)
31+
3032
## Features
3133

3234
**PyRadio** provides the following features:
@@ -72,7 +74,7 @@ After a successful installation, the command to execute is:
7274

7375
pyradio
7476

75-
This will display the program's window with a list of predefined radio stations ready to play.
77+
This will display the program's window with a list of predefined radio stations ready to be played.
7678

7779
- Select one of the station (using the arrow keys) and press "**ENTER**" to start playback.
7880

devel/build_install_pyradio

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ for prog in sed ;do
350350
${prog} --version 2>/dev/null 1>&2 || {
351351
if [ "${prog}" = "sed" ]
352352
then
353-
sed 's/a/b/' LICENCE > /dev/null ||{
353+
sed 's/a/b/' LICENSE > /dev/null ||{
354354
echo "Error: ${prog} not found."
355355
echo " Please install it and try again."
356356
exit 1
@@ -439,12 +439,21 @@ fi
439439
if [ -z "$PIPX" ]
440440
then
441441
# Normanl, old style installation
442+
if [ "${TO_PYTHON}" = "2" ]
443+
then
444+
cp setup.py setup.py.orig
445+
sed -i \
446+
-e 's/, find_namespace_packages/, find_packages/' \
447+
-e 's/find_namespace_packages.*/find_packages(),/' \
448+
setup.py
449+
fi
442450
if [ -e requirements.txt ]
443451
then
444452
python"${TO_PYTHON}" -m pip install -r requirements.txt . || pip_error
445453
else
446454
python"${TO_PYTHON}" -m pip install . || pip_error
447455
fi
456+
[ -e setup.py.orig ] && cp setup.py.orig setup.py
448457
else
449458
# pipx installation
450459
# MacOS will always permorm an fully isolated installation
@@ -475,6 +484,7 @@ do_undev
475484
if [ $? -eq 0 ]
476485
then
477486
[ -z "${NO_DEV}" ] && [ -e pyradio/config.py.dev ] && mv pyradio/config.py.dev pyradio/config.py
487+
cd docs
478488
gzip -k pyradio.1
479489
gzip -k pyradio_rb.1
480490
gzip -k pyradio_rec.1
@@ -492,18 +502,19 @@ then
492502
DOC=~/.local/local/share/doc/pyradio
493503
mkdir "$DOC"
494504
fi
495-
for n in docs/*.md docs/*.html
505+
for n in *.md *.html
496506
do
497507
cp "$n" "$DOC"
498508
done
499-
# copy LICENCE
509+
cd ..
510+
# copy LICENSE
500511
mkdir -p ~/.local/share/licenses 2>/dev/null
501512
if [ "$DOC" = "~/.local/share/doc/pyradio" ]
502513
then
503514
mkdir -p ~/.local/share/licenses/pyradio 2>/dev/null
504-
cp LICENCE ~/.local/share/licenses/pyradio
515+
cp LICENSE ~/.local/share/licenses/pyradio
505516
else
506-
cp LICENCE "$DOC"
517+
cp LICENSE "$DOC"
507518
fi
508519
if [ $(uname -s) != "Darwin" ] && [ $(uname -s) != "darwin" ]
509520
then
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/recording.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,7 @@ <h5 id="windows">Windows</h5>
250250
If you have decided to use one of the <strong>portable</strong> versions of <a target="_blank" href="https://mkvtoolnix.download/">MKVToolNix</a> on <strong>Windows 10</strong> or <strong>11</strong>, download that <strong>7z</strong> file instead.</p></li>
251251
<li><p>“Install” it in <strong>PyRadio Configuration Folder</strong>.<br />
252252
<br />
253-
To do that, open <strong>PyRadio</strong> and press “<em>\o</em>” to open the configuradio folder in the File Explorer.<br />
254-
</p></li>
253+
To do that, either press “<em>\o</em>” in <strong>PyRadio</strong>, or execute pyradio -od, to open the configuration folder in the File Explorer.</p></li>
255254
<li><p>Create a folder named “<strong>mkvtoolnix</strong></p></li>
256255
<li><p>Extract the <strong>7z</strong> file you previously downloaded, in the “<strong>mkvtoolnix</strong>” folder.</p></li>
257256
</ol>
@@ -321,6 +320,6 @@ <h2 id="listing-recordings-and-the--mkv-command-line-option">Listing recordings
321320
<p>could actually be inserted as</p>
322321
<pre>pyradio -mkv 1 -srt</pre>
323322
<p>In this case, <strong>1</strong> is the index of the file in the list provided by the <strong>-lr</strong> command.</p>
324-
<p>As a convenience, negative numbers can also be used; <strong>-1</strong> means the last file, <strong>-2</strong> the second from last, etc. This way, to work with the last recorded file, one would just use “<strong>-mkv -1</strong>” on all the necessary commands.</p>
323+
<p>As a convenience, negative numbers can also be used; <strong>-1</strong> means the last file, <strong>-2</strong> the second to last, etc. This way, to work with the last recorded file, one would just use “<strong>-mkv -1</strong>” on all the necessary commands.</p>
325324
</body>
326325
</html>

docs/recording.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ If you have decided to use one of the **portable** versions of [MKVToolNix](http
286286

287287
2. "Install" it in **PyRadio Configuration Folder**. \
288288
\
289-
To do that, open **PyRadio** and press "*\\o*" to open the configuradio folder in the File Explorer. \
289+
To do that, either press "*\\o*" in **PyRadio**, or execute `pyradio -od`, to open the configuration folder in the File Explorer.
290290

291291
3. Create a folder named "**mkvtoolnix**"
292292

@@ -416,5 +416,5 @@ pyradio -mkv 1 -srt
416416

417417
In this case, **1** is the index of the file in the list provided by the **-lr** command.
418418

419-
As a convenience, negative numbers can also be used; **-1** means the last file, **-2** the second from last, etc. This way, to work with the last recorded file, one would just use "**-mkv -1**" on all the necessary commands.
419+
As a convenience, negative numbers can also be used; **-1** means the last file, **-2** the second to last, etc. This way, to work with the last recorded file, one would just use "**-mkv -1**" on all the necessary commands.
420420

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ authors = [
77
]
88
description = "Command line internet radio player"
99
readme = "README.md"
10+
license = {file = "LICENSE"}
1011
requires-python = ">=3.7"
1112
classifiers = [
1213
"Programming Language :: Python :: 2.7",

0 commit comments

Comments
 (0)