migrate from setup.py to pyproject.toml

MANIFEST.in

@@ -1,2 +1,6 @@
 include LICENSES/GPL-3.0-or-later.txt
 include README.md
+
+graft safeeyes
+
+global-exclude *.py[cod]

README.md

@@ -200,8 +200,8 @@ To ensure the new strings are well-formed, you can use `python validate_po.py --
 1. Checkout the latest commits from the `master` branch
 2. Run `python3 -m safeeyes` to make sure nothing is broken
 3. Update the Safe Eyes version in the following places (Open the project in VSCode and search for the current version):
-    - [setup.py](https://github.com/slgobinath/SafeEyes/blob/master/setup.py#L83)
+    - [pyproject.toml](https://github.com/slgobinath/SafeEyes/blob/master/pyproject.toml#L4)
-    - [setup.py](https://github.com/slgobinath/SafeEyes/blob/master/setup.py#L90)
+    - [pyproject.toml](https://github.com/slgobinath/SafeEyes/blob/master/pyproject.toml#L36)
     - [safeeyes.py](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/safeeyes.py#L42)
     - [io.github.slgobinath.SafeEyes.metainfo.xml](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/platform/io.github.slgobinath.SafeEyes.metainfo.xml#L56)
     - [about_dialog.glade](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/glade/about_dialog.glade#L74)

pyproject.toml

@@ -0,0 +1,49 @@
+
+[project]
+name = "safeeyes"
+version = "2.2.2"
+description = "Protect your eyes from eye strain using this continuous breaks reminder."
+keywords = ["linux utility health eye-strain safe-eyes"]
+readme = "README.md"
+authors = [
+    {name = "Gobinath Loganathan", email = "slgobinath@gmail.com"},
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: X11 Applications :: GTK",
+    "Environment :: Other Environment",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "PyGObject",
+    "babel",
+    "psutil",
+    "packaging",
+    "python-xlib",
+]
+requires-python = ">=3.10"
+
+[project.urls]
+Homepage = "https://github.com/slgobinath/SafeEyes"
+Downloads = "https://github.com/slgobinath/SafeEyes/archive/v2.2.2.tar.gz"
+
+[project.scripts]
+safeeyes = "safeeyes.__main__:main"
+
+[project.optional-dependencies]
+healthstats = ["croniter"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages=["safeeyes"]
+include-package-data = true

setup.py

@@ -1,27 +1,44 @@
-import os, sys, site
+#!/usr/bin/python3
-import subprocess
+
-import setuptools
+import os
+
+from pathlib import Path
+from setuptools import Command, setup
+from setuptools.command.build import build as orig_build
+
+class build(orig_build):
+    sub_commands = [('build_mo', None), *orig_build.sub_commands]
 
 
-requires = [
+class build_mo(Command):
-    'babel',
+    description = 'Compile .po files into .mo files'
-    'psutil',
-    'croniter',
-    'PyGObject',
-    'packaging',
-    'python-xlib'
-]
 
-_ROOT = os.path.abspath(os.path.dirname(__file__))
+    files = None
 
-with open(os.path.join(_ROOT, 'README.md')) as f:
+    def initialize_options(self):
-    long_description = f.read()
+        self.files = None
+        self.editable_mode = False
+        self.build_lib = None
 
+    def finalize_options(self):
+        self.set_undefined_options("build_py", ("build_lib", "build_lib"))
+        pass
+
+    def run(self):
+        files = self._get_files()
+
+        for build_file, source_file in files.items():
+            if not self.editable_mode:
+                # Parent directory required for msgfmt to work correctly
+                Path(build_file).parent.mkdir(parents=True, exist_ok=True)
+            self.spawn(['msgfmt', source_file, '-o', build_file])
+
+    def _get_files(self):
+        if self.files is not None:
+            return self.files
+
+        files = {}
 
-def __compile_po_files():
-    """
-    Compile the *.po trainslation files.
-    """
         localedir = 'safeeyes/config/locale'
         po_dirs = [localedir + '/' + l + '/LC_MESSAGES/'
                    for l in next(os.walk(localedir))[1]]
@@ -32,72 +49,28 @@ def __compile_po_files():
             for po_file in po_files:
                 filename, _ = os.path.splitext(po_file)
                 mo_file = filename + '.mo'
-            msgfmt_cmd = 'msgfmt {} -o {}'.format(
+
-                po_dir + po_file, po_dir + mo_file)
+                source_file = po_dir + po_file
-            subprocess.call(msgfmt_cmd, shell=True)
+
+                build_file = po_dir + mo_file
+                if not self.editable_mode:
+                    build_file = os.path.join(self.build_lib, build_file)
+
+                files[build_file] = source_file
+
+        self.files = files
+        return files
+
+    def get_output_mapping(self):
+        return self._get_files()
+
+    def get_outputs(self):
+        return self._get_files().keys()
+
+    def get_source_files(self):
+        return  self._get_files().values()
 
 
-def __data_files():
+setup(
-    """
+    cmdclass={'build': build, 'build_mo': build_mo}
-    Collect the data files.
-    """
-    root_dir = sys.prefix
-    return [(os.path.join(root_dir, "share/applications"), ["safeeyes/platform/io.github.slgobinath.SafeEyes.desktop"]),
-    (os.path.join(root_dir, "share/icons/hicolor/24x24/status"), ["safeeyes/platform/icons/hicolor/24x24/status/io.github.slgobinath.SafeEyes-disabled.png", "safeeyes/platform/icons/hicolor/24x24/status/io.github.slgobinath.SafeEyes-enabled.png", "safeeyes/platform/icons/hicolor/24x24/status/io.github.slgobinath.SafeEyes-timer.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/24x24/apps"), ["safeeyes/platform/icons/hicolor/24x24/apps/io.github.slgobinath.SafeEyes.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/16x16/status"), ["safeeyes/platform/icons/hicolor/16x16/status/io.github.slgobinath.SafeEyes-disabled.png", "safeeyes/platform/icons/hicolor/16x16/status/io.github.slgobinath.SafeEyes-enabled.png", "safeeyes/platform/icons/hicolor/16x16/status/io.github.slgobinath.SafeEyes-timer.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/16x16/apps"), ["safeeyes/platform/icons/hicolor/16x16/apps/io.github.slgobinath.SafeEyes.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/32x32/status"), ["safeeyes/platform/icons/hicolor/32x32/status/io.github.slgobinath.SafeEyes-disabled.png", "safeeyes/platform/icons/hicolor/32x32/status/io.github.slgobinath.SafeEyes-enabled.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/32x32/apps"), ["safeeyes/platform/icons/hicolor/32x32/apps/io.github.slgobinath.SafeEyes.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/64x64/apps"), ["safeeyes/platform/icons/hicolor/64x64/apps/io.github.slgobinath.SafeEyes.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/128x128/apps"), ["safeeyes/platform/icons/hicolor/128x128/apps/io.github.slgobinath.SafeEyes.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/48x48/status"), ["safeeyes/platform/icons/hicolor/48x48/status/io.github.slgobinath.SafeEyes-disabled.png", "safeeyes/platform/icons/hicolor/48x48/status/io.github.slgobinath.SafeEyes-enabled.png"]),
-    (os.path.join(root_dir, "share/icons/hicolor/48x48/apps"), ["safeeyes/platform/icons/hicolor/48x48/apps/io.github.slgobinath.SafeEyes.png"]),]
-
-
-def __package_files(directory):
-    """
-    Collect the package files.
-    """
-    paths = []
-    for (path, _, filenames) in os.walk(directory):
-        for filename in filenames:
-            paths.append(os.path.join('..', path, filename))
-    return paths
-
-
-def __package_data():
-    """
-    Return a list of package data.
-    """
-    __compile_po_files()
-    data = ['glade/*.glade', 'resource/*']
-    data.extend(__package_files('safeeyes/config'))
-    data.extend(__package_files('safeeyes/plugins'))
-    data.extend(__package_files('safeeyes/platform'))
-    return data
-
-setuptools.setup(
-    name="safeeyes",
-    version="2.2.2",
-    description="Protect your eyes from eye strain using this continuous breaks reminder.",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author="Gobinath Loganathan",
-    author_email="slgobinath@gmail.com",
-    url="https://github.com/slgobinath/SafeEyes",
-    download_url="https://github.com/slgobinath/SafeEyes/archive/v2.2.2.tar.gz",
-    packages=setuptools.find_packages(),
-    package_data={'safeeyes': __package_data()},
-    data_files=__data_files(),
-    install_requires=requires,
-    entry_points={'console_scripts': ['safeeyes = safeeyes.__main__:main']},
-    keywords='linux utility health eye-strain safe-eyes',
-    classifiers=[
-        "Operating System :: POSIX :: Linux",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-        "Development Status :: 5 - Production/Stable",
-        "Environment :: X11 Applications :: GTK",
-        "Intended Audience :: End Users/Desktop",
-        "Topic :: Utilities"] + [('Programming Language :: Python :: %s' % x) for x in '3 3.5 3.6 3.7 3.8 3.9'.split()]
 )