setup.py

#
# This file is part of Dragonfly.
# (c) Copyright 2007, 2008 by Christo Butcher
# Licensed under the LGPL.
#
#   Dragonfly is free software: you can redistribute it and/or modify it
#   under the terms of the GNU Lesser General Public License as published
#   by the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   Dragonfly is distributed in the hope that it will be useful, but
#   WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#   Lesser General Public License for more details.
#
#   You should have received a copy of the GNU Lesser General Public
#   License along with Dragonfly.  If not, see
#   <http://www.gnu.org/licenses/>.
#

import os.path
import re
import sys

from setuptools import setup, find_packages, Command

#---------------------------------------------------------------------------
# Gather version from distribution file.

directory = os.path.abspath(os.path.dirname(__file__))
path = os.path.join(directory, "version.txt")
with open(path) as f:
    version_string = f.readline()
match = re.match(r"\s*(?P<rel>(?P<ver>\d+\.\d+)(?:\.\S+)*)\s*", version_string)
version = match.group("ver")
release = match.group("rel")

#---------------------------------------------------------------------------
# Gather test requirements from the 'test_requirements.txt' file.
# This is to allow installing test requirements with the following command:
# pip install dragonfly[test].

def read(name):
    with open(os.path.join(os.path.dirname(__file__), name)) as f:
        return f.read()

test_requirements = read("test_requirements.txt").split("\n")[:-1]

#---------------------------------------------------------------------------
# Override the 'test' command to use pytest instead.

class test(Command):
    description = 'run unit tests and doctests after in-place build'
    user_options = [
        # (long option, short option, description)
        # '=' means an argument should be supplied.
        ('test-suite=', None, 'Dragonfly engine to test (default: "text")'),
        ('pytest-options=', 'o',
            'pytest options (ex: "-s" to expose stdout/stdin)'),
    ]

    def initialize_options(self):
        self.test_suite = 'text'
        self.pytest_options = ''

    def finalize_options(self):
        # Check that 'test_suite' is an engine name.
        from dragonfly.test.suites import engine_tests_dict
        suite = self.test_suite
        assert suite in engine_tests_dict.keys(), \
            "the test suite value must be an engine name, not '%s'" % suite

        # Split pytest options into a list.
        self.pytest_options = self.pytest_options.split()

    def run(self):
        from dragonfly.test.suites import run_pytest_suite
        test_suite = self.test_suite

        # If a Natlink PYD file exists in the current working directory, we
        #  attempt to import and use it to test Natlink.  This is easier
        #  than reinstalling different versions of the program.
        if test_suite == "natlink":
            self._try_local_natlink_pyd()

        print("Test suite running for engine '%s'" % test_suite)
        result = run_pytest_suite(test_suite, self.pytest_options)

        # Exit using pytest's return code.
        exit(int(result))

    def _try_local_natlink_pyd(self):
        natlink = None
        try:
            if os.path.exists("natlink.pyd"):
                print("Attempting to import local natlink.pyd file for"
                      " testing.")
                import natlink
            elif os.path.exists("_natlink_core.pyd"):
                print("Attempting to import local _natlink_core.pyd file"
                      " for testing.")
                import _natlink_core as natlink
        except ImportError as e:
            print("Could not import file: %s" % e)
            print("Falling back on the installed version of Natlink.\n")

        # If a local PYD file exists and was imported successfully, add the
        #  module to sys.modules.
        if natlink: sys.modules["natlink"] = natlink

#---------------------------------------------------------------------------
# Set up package.

setup(
      name             = "dragonfly",
      version          = release,
      description      = "Speech recognition extension library",
      author           = "Christo Butcher",
      author_email     = "dist.dragonfly@twizzy.biz",
      maintainer       = "Dane Finlay",
      maintainer_email = "dane@danefinlay.net",
      license          = "LICENSE.txt",
      url              = "https://github.com/dictation-toolbox/dragonfly",
      zip_safe         = False,  # To unzip documentation files.
      long_description = read("README.rst"),
      include_package_data=True,
      install_requires=[
                        "setuptools >= 40.0.0",
                        "packaging >= 19.0",
                        "six",
                        "lark-parser >= 0.8.0",

                        # Windows-only dependencies.
                        "pywin32;platform_system=='Windows'",

                        # Common POSIX dependencies.
                        # "python-libxdo;os_name=='posix'",
                        # "Xlib;os_name=='posix'",
                        "psutil >= 5.5.1;os_name=='posix'",
                        "pyperclip >= 1.7.0;os_name=='posix'",
                        "pynput >= 1.7.6;os_name=='posix'",

                        # Mac OS dependencies.
                        "pyobjc >= 5.2;platform_system=='Darwin'",
                        "py-applescript == 1.0.0;platform_system=='Darwin'",
                       ],

      extras_require={
          "test": test_requirements,
          "accessibility": [
                            "comtypes;platform_system=='Windows'",
                            "enum34;python_version<'3.4'",
                            "regex<2022.1.18;python_version<='2.7'",
                            "regex;python_version>'2.7'",
                           ],
          "sphinx": [
                     "sounddevice == 0.3.*",
                     "sphinxwrapper >= 1.3.0",
                     "pyjsgf == 1.9.*",
                    ],
          "kaldi": [
                    # NOTE: Remember to also update engine.py to the same version!
                    "kaldi-active-grammar ~= 3.1.0",
                    "sounddevice == 0.3.*",
                    "webrtcvad-wheels == 2.0.*",
                   ],
          "playsound": [
                        "sounddevice == 0.3.*;os_name=='posix'",
                       ],
      },

      cmdclass={
          "test": test,
      },

      classifiers=[
                   "Development Status :: 5 - Production/Stable",
                   "Environment :: Win32 (MS Windows)",
                   "Environment :: X11 Applications",
                   "Environment :: MacOS X",
                   "License :: OSI Approved :: "
                   "GNU Library or Lesser General Public License (LGPL)",
                   "Intended Audience :: Developers",
                   "Operating System :: Microsoft :: Windows",
                   "Operating System :: POSIX",
                   "Operating System :: MacOS",
                   "Programming Language :: Python :: 2.7",
                   "Programming Language :: Python :: 3.4",
                   "Programming Language :: Python :: 3.5",
                   "Programming Language :: Python :: 3.6",
                   "Programming Language :: Python :: 3.7",
                   "Programming Language :: Python :: 3.8",
                   "Programming Language :: Python :: 3.9",
                   "Programming Language :: Python :: 3.10",
                   "Programming Language :: Python :: Implementation :: CPython",
                   "Topic :: Multimedia :: Sound/Audio :: Speech",
                   "Topic :: Software Development :: Libraries :: Python Modules",
                  ],

      packages=find_packages(),

      test_suite="dragonfly.test.suites.text_suite",
     )