Modernize installation.

This commit is contained in:
Storm Dragon 2024-12-20 11:04:13 -05:00
parent 55ce73322b
commit d6a9332f80
2 changed files with 120 additions and 115 deletions

52
pyproject.toml Normal file
View File

@ -0,0 +1,52 @@
[build-system]
requires = ["setuptools>=64.0.0", "wheel", "setuptools_scm[toml]>=6.2"]
build-backend = "setuptools.build_meta"
[project]
name = "fenrir-screenreader"
dynamic = ["version"]
description = "A TTY Screen Reader for Linux"
readme = "README.md"
requires-python = ">=3.8"
license = {text = "GNU General Public License v3 or later (GPLv3+)"}
keywords = ["screenreader", "a11y", "accessibility", "terminal", "TTY", "console"]
authors = [
{name = "Storm Dragon, Jeremiah, Chrys and others", email = "storm_dragon@stormux.org"}
]
classifiers = [
"Programming Language :: Python",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Development Status :: 5 - Production/Stable",
"Topic :: Multimedia :: Sound/Audio :: Speech",
"Environment :: Console",
]
dependencies = [
"evdev>=1.1.2",
"daemonize>=2.5.0",
"dbus-python>=1.2.8",
"pyudev>=0.21.0",
"setuptools",
"pexpect",
"pyttsx3",
"pyte>=0.7.0",
]
[project.urls]
Homepage = "https://git.stormux.org/storm/fenrir/"
[tool.setuptools]
package-dir = {"" = "src"}
include-package-data = true
zip-safe = false
[tool.setuptools.packages.find]
where = ["src"]
include = ["fenrirscreenreader*"]
namespaces = true
[tool.setuptools_scm]
write_to = "src/fenrirscreenreader/_version.py"
[tool.setuptools.data-files]
"usr/share/man/man1" = ["docs/fenrir.1"]
"usr/share/fenrirscreenreader/tools" = ["tools/*"]

131
setup.py
View File

@ -1,120 +1,62 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
#https://python-packaging.readthedocs.io/en/latest/minimal.html import os
import os, glob, sys import sys
import os.path import glob
from shutil import copyfile from shutil import copyfile
from setuptools import find_packages
from setuptools import setup from setuptools import setup
# handle flags for package manager like aurman and pacaur. def get_data_files(force_settings=False):
forceSettingsFlag = False data_files = []
if "--force-settings" in sys.argv:
forceSettingsFlag = True
sys.argv.remove("--force-settings")
dataFiles = []
# Handle locale files # Handle locale files
localeFiles = glob.glob('locale/*/LC_MESSAGES/*.mo') locale_files = glob.glob('locale/*/LC_MESSAGES/*.mo')
for localeFile in localeFiles: for locale_file in locale_files:
lang = localeFile.split(os.sep)[1] lang = locale_file.split(os.sep)[1]
destDir = f'/usr/share/locale/{lang}/LC_MESSAGES' dest_dir = f'/usr/share/locale/{lang}/LC_MESSAGES'
dataFiles.append((destDir, [localeFile])) data_files.append((dest_dir, [locale_file]))
# Handle other configuration files # Handle configuration files
directories = glob.glob('config/*') directories = glob.glob('config/*')
for directory in directories: for directory in directories:
files = glob.glob(directory+'/*') files = glob.glob(directory+'/*')
destDir = '' dest_dir = ''
if 'config/punctuation' in directory: if 'config/punctuation' in directory:
destDir = '/etc/fenrirscreenreader/punctuation' dest_dir = '/etc/fenrirscreenreader/punctuation'
elif 'config/keyboard' in directory: elif 'config/keyboard' in directory:
destDir = '/etc/fenrirscreenreader/keyboard' dest_dir = '/etc/fenrirscreenreader/keyboard'
elif 'config/settings' in directory: elif 'config/settings' in directory:
destDir = '/etc/fenrirscreenreader/settings' dest_dir = '/etc/fenrirscreenreader/settings'
if not forceSettingsFlag: if not force_settings:
try: try:
del(files[files.index('config/settings/settings.conf')]) files.remove('config/settings/settings.conf')
except: except ValueError:
pass pass
elif 'config/scripts' in directory: elif 'config/scripts' in directory:
destDir = '/usr/share/fenrirscreenreader/scripts' dest_dir = '/usr/share/fenrirscreenreader/scripts'
if destDir != '': if dest_dir:
dataFiles.append((destDir, files)) data_files.append((dest_dir, files))
# Handle sound files
files = glob.glob('config/sound/default/*') files = glob.glob('config/sound/default/*')
destDir = '/usr/share/sounds/fenrirscreenreader/default' data_files.append(('/usr/share/sounds/fenrirscreenreader/default', files))
dataFiles.append((destDir, files)) files = glob.glob('config/sound/template/*')
files = glob.glob('config/sound//template/*') data_files.append(('/usr/share/sounds/fenrirscreenreader/template', files))
destDir = '/usr/share/sounds/fenrirscreenreader/template'
dataFiles.append((destDir, files))
files = glob.glob('tools/*')
dataFiles.append(('/usr/share/fenrirscreenreader/tools', files))
dataFiles.append(('/usr/share/man/man1', ['docs/fenrir.1']))
def read(fname): return data_files
return open(os.path.join(os.path.dirname(__file__), fname)).read()
setup( def post_install_actions():
# Application name: if '--force-settings' not in sys.argv:
name="fenrir-screenreader",
# Version is now handled by setuptools_scm
use_scm_version=True,
setup_requires=['setuptools_scm'],
# description
description="A TTY Screen Reader for Linux.",
long_description=read('README.md'),
keywords=['screenreader', 'a11y', 'accessibility', 'terminal', 'TTY', 'console'],
license="License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
url="https://git.stormux.org/storm/fenrir/",
# Remove download_url as it contained hardcoded version
classifiers=[
"Programming Language :: Python",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"Development Status :: 5 - Production/Stable",
"Topic :: Multimedia :: Sound/Audio :: Speech",
"Environment :: Console",
],
# Application author details:
author="Storm Dragon, Jeremiah, Chrys and others",
author_email="storm_dragon@stormux.org",
# Packages
packages=find_packages('src/'),
package_dir={'': 'src/'},
scripts=['src/fenrir'],
# Include additional files into the package
include_package_data=True,
zip_safe=False,
data_files=dataFiles,
# Dependent packages (distributions)
install_requires=[
"evdev>=1.1.2",
"daemonize>=2.5.0",
"dbus-python>=1.2.8",
"pyudev>=0.21.0",
"setuptools",
"pexpect",
"pyttsx3",
"pyte>=0.7.0",
],
)
if not forceSettingsFlag:
print('') print('')
# create settings file from example if not exist # create settings file from example if not exist
if not os.path.isfile('/etc/fenrirscreenreader/settings/settings.conf'): if not os.path.isfile('/etc/fenrirscreenreader/settings/settings.conf'):
try: try:
copyfile('/etc/fenrirscreenreader/settings/settings.conf.example', '/etc/fenrirscreenreader/settings/settings.conf') copyfile('/etc/fenrirscreenreader/settings/settings.conf.example',
'/etc/fenrirscreenreader/settings/settings.conf')
print('create settings file in /etc/fenrirscreenreader/settings/settings.conf') print('create settings file in /etc/fenrirscreenreader/settings/settings.conf')
except: except:
pass pass
else: else:
print('settings.conf file found. It is not overwritten automatical') print('settings.conf file found. It is not overwritten automatically')
print('') print('')
print('To have Fenrir start at boot:') print('To have Fenrir start at boot:')
@ -126,3 +68,14 @@ print('Please install the following packages manually:')
print('- Speech-dispatcher: for the default speech driver') print('- Speech-dispatcher: for the default speech driver')
print('- Espeak: as basic TTS engine') print('- Espeak: as basic TTS engine')
print('- sox: is a player for the generic sound driver') print('- sox: is a player for the generic sound driver')
if __name__ == "__main__":
force_settings = '--force-settings' in sys.argv
if force_settings:
sys.argv.remove('--force-settings')
setup(
data_files=get_data_files(force_settings),
)
post_install_actions()