Skip to content

Commit

Permalink
- updating setup.py and pyproject.toml for latest installayion method
Browse files Browse the repository at this point in the history
- moving man pages to docs
- updating docs
  • Loading branch information
s-n-g committed Nov 23, 2023
1 parent a37b2ac commit e0ad0a5
Show file tree
Hide file tree
Showing 12 changed files with 1,593 additions and 13 deletions.
File renamed without changes.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ If you face this situation, please refer to [this page](docs/pip-error.md) to re

<!-- vim-markdown-toc -->

* Please follow this link for the [Detailed documentation](docs/index.md)

## Features

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

pyradio

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

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

Expand Down
21 changes: 16 additions & 5 deletions devel/build_install_pyradio
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ for prog in sed ;do
${prog} --version 2>/dev/null 1>&2 || {
if [ "${prog}" = "sed" ]
then
sed 's/a/b/' LICENCE > /dev/null ||{
sed 's/a/b/' LICENSE > /dev/null ||{
echo "Error: ${prog} not found."
echo " Please install it and try again."
exit 1
Expand Down Expand Up @@ -439,12 +439,21 @@ fi
if [ -z "$PIPX" ]
then
# Normanl, old style installation
if [ "${TO_PYTHON}" = "2" ]
then
cp setup.py setup.py.orig
sed -i \
-e 's/, find_namespace_packages/, find_packages/' \
-e 's/find_namespace_packages.*/find_packages(),/' \
setup.py
fi
if [ -e requirements.txt ]
then
python"${TO_PYTHON}" -m pip install -r requirements.txt . || pip_error
else
python"${TO_PYTHON}" -m pip install . || pip_error
fi
[ -e setup.py.orig ] && cp setup.py.orig setup.py
else
# pipx installation
# MacOS will always permorm an fully isolated installation
Expand Down Expand Up @@ -475,6 +484,7 @@ do_undev
if [ $? -eq 0 ]
then
[ -z "${NO_DEV}" ] && [ -e pyradio/config.py.dev ] && mv pyradio/config.py.dev pyradio/config.py
cd docs
gzip -k pyradio.1
gzip -k pyradio_rb.1
gzip -k pyradio_rec.1
Expand All @@ -492,18 +502,19 @@ then
DOC=~/.local/local/share/doc/pyradio
mkdir "$DOC"
fi
for n in docs/*.md docs/*.html
for n in *.md *.html
do
cp "$n" "$DOC"
done
# copy LICENCE
cd ..
# copy LICENSE
mkdir -p ~/.local/share/licenses 2>/dev/null
if [ "$DOC" = "~/.local/share/doc/pyradio" ]
then
mkdir -p ~/.local/share/licenses/pyradio 2>/dev/null
cp LICENCE ~/.local/share/licenses/pyradio
cp LICENSE ~/.local/share/licenses/pyradio
else
cp LICENCE "$DOC"
cp LICENSE "$DOC"
fi
if [ $(uname -s) != "Darwin" ] && [ $(uname -s) != "darwin" ]
then
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 2 additions & 3 deletions docs/recording.html
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,7 @@ <h5 id="windows">Windows</h5>
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>
<li><p>“Install” it in <strong>PyRadio Configuration Folder</strong>.<br />
<br />
To do that, open <strong>PyRadio</strong> and press “<em>\o</em>” to open the configuradio folder in the File Explorer.<br />
</p></li>
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>
<li><p>Create a folder named “<strong>mkvtoolnix</strong></p></li>
<li><p>Extract the <strong>7z</strong> file you previously downloaded, in the “<strong>mkvtoolnix</strong>” folder.</p></li>
</ol>
Expand Down Expand Up @@ -321,6 +320,6 @@ <h2 id="listing-recordings-and-the--mkv-command-line-option">Listing recordings
<p>could actually be inserted as</p>
<pre>pyradio -mkv 1 -srt</pre>
<p>In this case, <strong>1</strong> is the index of the file in the list provided by the <strong>-lr</strong> command.</p>
<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>
<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>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ If you have decided to use one of the **portable** versions of [MKVToolNix](http

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

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

Expand Down Expand Up @@ -416,5 +416,5 @@ pyradio -mkv 1 -srt

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

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.
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.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ authors = [
]
description = "Command line internet radio player"
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 2.7",
Expand Down
Loading

0 comments on commit e0ad0a5

Please sign in to comment.