setup.py

   1 # =============================================================================
   2 #               ____ _   _ ____  _
   3 #  _ __  _   _ / ___| | | |  _ \| |
   4 # | '_ \| | | | |  _| |_| | | | | |
   5 # | |_) | |_| | |_| |  _  | |_| | |___
   6 # | .__/ \__, |\____|_| |_|____/|_____|
   7 # |_|    |___/
   8 # =============================================================================
   9 #  Authors:
  10 #    Tristan Gingold
  11 #    Patrick Lehmann
  12 #    Unai Martinez-Corral
  13 #
  14 # Package installer:  Python binding for GHDL and high-level APIs.
  15 #
  16 # License:
  17 # ============================================================================
  18 #  Copyright (C) 2019-2021 Tristan Gingold
  19 #
  20 #  This program is free software: you can redistribute it and/or modify
  21 #  it under the terms of the GNU General Public License as published by
  22 #  the Free Software Foundation, either version 2 of the License, or
  23 #  (at your option) any later version.
  24 #
  25 #  This program is distributed in the hope that it will be useful,
  26 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 #  GNU General Public License for more details.
  29 #
  30 #  You should have received a copy of the GNU General Public License
  31 #  along with this program.  If not, see <gnu.org/licenses>.
  32 #
  33 # SPDX-License-Identifier: GPL-2.0-or-later
  34 # ============================================================================
  35 #
  36 from pathlib             import Path
  37 from pyTooling.Licensing import GPL_2_0_or_later
  38 from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub
  39
  40 gitHubNamespace = "ghdl"
  41 packageName =  "pyGHDL"
  42 packageDirectory = packageName
  43 packageInformationFile = Path(f"{packageDirectory}/__init__.py")
  44 requirementsFile = Path(f"{packageDirectory}/requirements.txt")
  45
  46 DescribePythonPackageHostedOnGitHub(
  47     packageName=packageName,
  48     description="Python binding for GHDL and high-level APIs (incl. LSP).",
  49     license=GPL_2_0_or_later,
  50     gitHubNamespace=gitHubNamespace,
  51     sourceFileWithVersion=packageInformationFile,
  52     requirementsFile=requirementsFile,
  53     developmentStatus="beta",
  54     classifiers=[
  55         "Operating System :: MacOS",
  56         "Operating System :: Microsoft :: Windows :: Windows 10",
  57         "Operating System :: POSIX :: Linux",
  58         "Intended Audience :: Developers",
  59         "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
  60         "Topic :: Software Development :: Code Generators",
  61         "Topic :: Software Development :: Compilers",
  62         "Topic :: Software Development :: Testing",
  63         "Topic :: Utilities",
  64     ],
  65     consoleScripts={
  66         "ghdl-ls": "pyGHDL.cli.lsp:main",
  67         "ghdl-dom": "pyGHDL.cli.dom:main"
  68     }
  69 )