Merge pull request #10 from jeanslack/testinstall

jeanslack · web-flow · commit 10b6e4109771 · 2023-08-11T11:46:18.000+02:00
info update and install tests
diff --git a/.gitignore b/.gitignore
@@ -20,4 +20,6 @@ Pipfile.lock
 *.DS_Store
 *.directory
 *.kate-swp
+portable_data
+My_Files
 *~
diff --git a/CHANGELOG b/CHANGELOG
@@ -7,7 +7,7 @@ License: GPL3
 Change Log:
 
 +------------------------------------+
-Thu, 10 Aug 2023 V.1.0.5 (unreleased)
+Thu, 11 Aug 2023 V.1.0.5 (unreleased)
 
 - Removed `wx.lib.mixins.listctrl` (with checkbox functionality)
 - Fixed code to new FFcuesplitter API v1.0.22.
@@ -17,9 +17,11 @@ Thu, 10 Aug 2023 V.1.0.5 (unreleased)
           conversion to integers using __int__ is deprecated, and may be removed
           in a future version of Python.
   self.barprog.SetValue(percent)`
-- Make output directory if doesn't exists (or if it was deleted)
+- Make output directory if doesn't exists (or if it was deleted).
 - Fixed output format issue.
 - Code factorized.
+- Updated README.md file and man page.
+- Updated INSTALL file for installation instructions.
 
 +------------------------------------+
 Dec 14, 2022 V.1.0.2 (unreleased)
diff --git a/INSTALL b/INSTALL
@@ -0,0 +1,69 @@
+Important Notes:
+----------------
+The instructions provided on this file assume you have Python installed and
+configured on your operating system.
+
+Currently FFcuesplitter-gui is still under development and no pre-compiled packages
+have been distributed, but since it comes with a `setup.py` file, you can build it
+and install it very easily into your operating system as a Python wheel.
+
+However, to achieve this a virtual python environment is recommended, for
+example using tools like `python3-venv` or `virtualenv`, which once activated,
+you can install packages in the virtual environment using pip and then installing
+FFcuesplitter-gui into it. At present, other installation methods that use
+administrative privileges such as superuser or root are strongly discouraged.
+
+Documentation:
+- https://docs.python.org/3/library/venv.html
+- https://docs.python-guide.org/dev/virtualenvs/
+- https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment
+- https://stackoverflow.com/questions/41573587/what-is-the-difference-between-venv-pyvenv-pyenv-virtualenv-virtualenvwrappe
+
+-----
+Linux
+-----
+
+First of all, install the essential packages using the package manager provided
+by your linux distribution, then install wxPython version 4.0.7 or higher.
+On debian-based distributions (Ubuntu, Kubuntu, Lubuntu, Mint, MXLinux, etc)
+this package is identified as `python3-wxgtk4.0` .
+Aldo make sure you have `ffmpeg` and `ffprobe` already installed.
+
+Activate your virtual Python directory:
+$ source 'path_to_environment_directory/bin/activate'
+
+To install FFcuesplitter-gui, open a terminal window and type:
+$ python3 -m pip install https://github.com/jeanslack/FFcuesplitter-GUI/tarball/main
+
+To run the program type:
+$ ffcuesplitter-gui
+
+-------
+Windows
+-------
+
+Activate your virtual Python directory:
+.\path_to_environment_directory\Scripts\activate
+
+To install FFcuesplitter-gui type:
+python -m pip install https://github.com/jeanslack/FFcuesplitter-GUI/tarball/main
+
+Make sure you have ffmpeg and ffprobe available somewhere on your system, as
+these dependencies are not provided automatically by FFcuesplitter-gui.
+
+Once you have ffmpeg and ffprobe, start FFcuesplitter-gui (just type ffcuesplitter-gui
+in your command prompt window), click the Setup button, go to the FFmpeg tab and
+provide the location on your file system.
+
+-----
+MacOS
+-----
+
+Activate your virtual Python directory:
+$ source 'path_to_environment_directory/bin/activate'
+
+To install FFcuesplitter-gui type:
+$ python3 -m pip install https://github.com/jeanslack/FFcuesplitter-GUI/tarball/main
+
+To run the program type:
+$ ffcuesplitter-gui
diff --git a/README.md b/README.md
@@ -1,30 +1,31 @@
-[![Image](https://img.shields.io/static/v1?label=python&logo=python&message=3.7%20|%203.8|%203.9&color=blue)](https://www.python.org/downloads/)
+[![Image](https://img.shields.io/static/v1?label=python&logo=python&message=3.7%20|%203.8%20|%203.9%20|%203.10|%203.11&color=blue)](https://www.python.org/downloads/)
 [![Image](https://img.shields.io/badge/license-GPLv3-orange)](https://github.com/jeanslack/FFcuesplitter-GUI/blob/main/LICENSE)
 
 # FFcuesplitter-GUI 
 
-Graphical interface for [FFcuesplitter](https://github.com/jeanslack/FFcuesplitter), 
-written in wxPython phoenix.
+A simple graphical user interface to extracts audio tracks from audio CD images 
+supplied with a CUE sheet.
 
 ![preview](./docs/gui_preview.gif)
 
 ## Description
 
-It is a cross-platform GUI for the [FFcuesplitter](https://github.com/jeanslack/FFcuesplitter) 
-library written in wxPython Phoenix. It features editable tags per track, checkboxes 
-to select track extractions, an audio CD properties viewer, support for WAV, 
-FLAC, MP3 and OGG output formats, audio compression selectors and the ability 
-to copy audio codec without re-encoding.
+FFcuesplitter-GUI is a cross-platform GUI written in wxPython Phoenix. It is 
+based on the [FFcuesplitter](https://github.com/jeanslack/FFcuesplitter) library, 
+which is based on FFmpeg for audio track extraction and encoding processes.
+It features editable tags per track, an audio CD properties viewer, support for 
+WAV, FLAC, MP3, OGG, OPUS output formats, audio compression selectors and the 
+ability to copy audio codec without re-encoding.
 
 ## Requirements
-- [Python >= 3.7.0](https://www.python.org/)
-- [wxPython-Phoenix >= 4.0.7](https://wxpython.org/)
-- [PyPubSub >= 4.0.3](https://pypi.org/project/PyPubSub/)
-- [ffcuesplitter >= 1.0.7](https://pypi.org/project/ffcuesplitter/)
-- [ffmpeg >=4.3](https://ffmpeg.org/)
-- [ffprobe >=4.3](https://ffmpeg.org/ffprobe.html)
+- **[Python >= 3.7.0](https://www.python.org/)**
+- **[wxPython-Phoenix >= 4.0.7](https://wxpython.org/)**
+- **[PyPubSub >= 4.0.3](https://pypi.org/project/PyPubSub/)**
+- **[ffcuesplitter >= 1.0.22](https://pypi.org/project/ffcuesplitter/)**
+- **[ffmpeg >=4.3](https://ffmpeg.org/)**
+- **[ffprobe >=4.3](https://ffmpeg.org/ffprobe.html)**
 
-## Running from source code
+## Running from source code (Unix/macOS)
 
 ```
 git clone https://github.com/jeanslack/FFcuesplitter-GUI.git
@@ -35,6 +36,22 @@ python3 -m pip install -r requirements.txt
 python3 launcher
 ```
 
+## Running from source code (Windows)
+
+```
+git clone https://github.com/jeanslack/FFcuesplitter-GUI.git
+cd FFcuesplitter-GUI
+python -m venv My_env
+.\My_env\Scripts\activate
+python -m pip install -r requirements.txt
+python launcher
+```
+
+## Installation
+
+Please, read the instructions provided with the [INSTALL](https://github.com/jeanslack/FFcuesplitter-GUI/blob/main/INSTALL) file
+
+
 ## Authors
 See [AUTHORS](AUTHORS) file
 
diff --git a/TODO b/TODO
@@ -1,9 +1,9 @@
 
 
-- check code with a linter (flake8/pylint)
+- [DONE] check code with a linter (flake8/pylint)
 - Make io.github.jeanslack.ffcuesplitter-gui.desktop.
-- Make ffcuesplitter-gui.icns.
-- make ffcuesplitter-gui.ico
+- Make ffcuesplitter-gui.icns (MacOs)
+- Make ffcuesplitter-gui.ico (Windows)
 
 - Complete the Italian translation.
 - Make localization guidelines
@@ -14,7 +14,8 @@
 - Make debian dir.
 - Write INSTALL basic for installations.
 
-BUG verifieds
-- Auto-make output folder if it doesn't exist.
-- The codec/output format is always flac even if you choose another format
+- [DONE] Auto-make output folder if it doesn't exist.
+- [DONE] The codec/output format is always flac even if you choose another format
   among those available (wav, opus, mp3, ogg)
+- Make GitHub workflow to test multiple Python version.
+- Fix button spaces as like confirmation buttons.
diff --git a/docs/man/man1/ffcuesplitter-gui.1.gz b/docs/man/man1/ffcuesplitter-gui.1.gz
diff --git a/ffcuesplitter_gui/_sys/info.py b/ffcuesplitter_gui/_sys/info.py
@@ -35,12 +35,13 @@
 __appname__ = "FFcuesplitter-gui"
 __packagename__ = "ffcuesplitter_gui"
 __license__ = "GPL3 (Gnu Public License)"
-__description__ = ("FFcuesplitter-gui extracts audio tracks from an audio CD "
-                   "image supplied with the CUE sheet, using FFmpeg.")
-__descriptionfull__ = """It is a cross-platform GUI for the FFcuesplitter
-library written in wxPython Phoenix. It features editable tags per track,
-checkboxes to select track extractions, an audio CD properties viewer, support
-for WAV, FLAC, MP3 and OGG output formats, audio compression selectors and the
+__description__ = ("A simple graphical user interface to extracts audio "
+                   "tracks from audio CD images supplied with a CUE sheet.")
+__descriptionfull__ = """FFcuesplitter-GUI is a cross-platform GUI written in
+wxPython Phoenix. It is based on the FFcuesplitter library, which is based on
+FFmpeg for audio track extraction and encoding processes.
+It features editable tags per track, an audio CD properties viewer, support for
+WAV, FLAC, MP3, OGG, OPUS output formats, audio compression selectors and the
 ability to copy audio codec without re-encoding.
 """
 __copyleft__ = '2023'
diff --git a/io.github.jeanslack.ffcuesplitter_gui.appdata.xml b/io.github.jeanslack.ffcuesplitter_gui.appdata.xml
@@ -3,21 +3,24 @@
   <id>io.github.jeanslack.ffcuesplitter_gui</id>
   
   <name>FFcuesplitter-gui</name>
-  <summary>A cross-platform GUI for the FFcuesplitter library written in wxPython Phoenix</summary>
+  <summary>
+  A simple graphical user interface to extracts audio tracks from audio CD 
+  images supplied with a CUE sheet.
+  </summary>
   
   <metadata_license>FSFAP</metadata_license>
   <project_license>AGPL-3.0-only</project_license>
   
   <description>
     <p>
-      FFcuesplitter-gui extracts audio tracks from an audio CD image supplied 
-      with the CUE sheet, using FFmpeg.
+      FFcuesplitter-GUI is a cross-platform GUI written in wxPython Phoenix. 
+      It is based on the FFcuesplitter library, which is based on FFmpeg for 
+      audio track extraction and encoding processes.
     </p>
     <p>
-      It features editable tags per track, checkboxes to select track 
-      extractions, an audio CD properties viewer, support for WAV, FLAC, MP3 and 
-      OGG output formats, audio compression selectors and the ability to copy 
-      audio codec without re-encoding.
+      It features editable tags per track, an audio CD properties viewer, 
+      support for WAV, FLAC, MP3, OGG, OPUS output formats, audio compression 
+      selectors and the ability to copy audio codec without re-encoding.
     </p>
   </description>
   
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 PyPubSub>=4.0.3
-ffcuesplitter>=1.0.7
+ffcuesplitter>=1.0.22
 
 [:platform_system == "Windows" or platform_system == "Darwin"]
 wxpython>=4.0.7 
diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 Writer: Gianluca Pernigotto <jeanlucperni@gmail.com>
 Copyright: 2023-2023 Gianluca Pernigotto <jeanlucperni@gmail.com>
 license: GPL3
-Rev: Feb.09.2022
+Rev: Aug.1.2023
 Code checker: flake8, pylint
 ########################################################
 
@@ -57,7 +57,7 @@ def source_build():
         inst_req = ["wxpython>=4.0.7; platform_system=='Windows' or "
                     "platform_system=='Darwin'",
                     "PyPubSub>=4.0.3",
-                    "ffcuesplitter>=1.0.7",
+                    "ffcuesplitter>=1.0.22",
                     ]
         setup_req = ["setuptools>=47.1.1",
                      "wheel>=0.34.2",
@@ -71,7 +71,7 @@ def source_build():
     else:  # e.g. to make a Debian source package, include wxpython.
         inst_req = ["wxpython>=4.0.7",
                     "PyPubSub>=4.0.3",
-                    "ffcuesplitter>=1.0.7",
+                    "ffcuesplitter>=1.0.22",
                     ]
         setup_req = []
         long_descript = __descriptionfull__
@@ -148,8 +148,10 @@ def source_build():
               'Natural Language :: Russian',
               'Programming Language :: Python :: 3 :: Only',
               'Programming Language :: Python :: 3.7',
-              "Programming Language :: Python :: 3.8",
-              "Programming Language :: Python :: 3.9",
+              'Programming Language :: Python :: 3.8',
+              'Programming Language :: Python :: 3.9',
+              'Programming Language :: Python :: 3.10',
+              'Programming Language :: Python :: 3.11',
               'Topic :: Multimedia :: Sound/Audio',
               'Topic :: Multimedia :: Sound/Audio :: Conversion',
               'Topic :: Multimedia :: Sound/Audio :: CD Audio :: CD Ripping',
