taipy/setup.py

# Copyright 2023 Avaiga Private Limited
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

"""The setup script."""


import json
import os
import sysconfig
from importlib.util import find_spec
from pathlib import Path

from setuptools import find_namespace_packages, find_packages, setup
from setuptools.command.build_py import build_py

with open("README.md", "rb") as readme_file:
    readme = readme_file.read().decode("UTF-8")

with open(f"src{os.sep}taipy{os.sep}version.json") as version_file:
    version = json.load(version_file)
    version_string = f'{version.get("major", 0)}.{version.get("minor", 0)}.{version.get("patch", 0)}'
    if vext := version.get("ext"):
        version_string = f"{version_string}.{vext}"

requirements = [
    "backports.zoneinfo>=0.2.1,<0.3;python_version<'3.9'",
    "cookiecutter>=2.1.1,<2.2",
    "taipy-gui>=3.0,<3.1",
    "taipy-rest>=3.0,<3.1",
    "taipy-templates>=3.0,<3.1",
]

setup_requirements = [(requirement for requirement in requirements if requirement.startswith("taipy-gui"))]

test_requirements = ["pytest>=3.8"]

extras_require = {
    "ngrok": ["pyngrok>=5.1,<6.0"],
    "image": [
        "python-magic>=0.4.24,<0.5;platform_system!='Windows'",
        "python-magic-bin>=0.4.14,<0.5;platform_system=='Windows'",
    ],
    "rdp": ["rdp>=0.8"],
    "arrow": ["pyarrow>=10.0.1,<11.0"],
    "mssql": ["pyodbc>=4"],
}


def _build_webapp():
    already_exists = Path("./src/taipy/gui_core/lib/taipy-gui-core.js").exists()
    if not already_exists:
        # default site-packages path is from the current python interpreter
        site_packages_path = sysconfig.get_path("purelib")
        # taipy-gui should be available through setup_requires option
        # taipy-gui at this step is installed in a backend site-packages separated from the one being used by pip
        if find_spec("taipy") and find_spec("taipy.gui"):
            import taipy

            site_packages_path = Path(taipy.__file__).absolute().parent.parent

        # Specify the correct path to taipy-gui in gui/.env file
        env_file_path = Path(__file__).absolute().parent / "gui" / ".env"
        if not os.path.exists(env_file_path):
            with open(env_file_path, "w") as env_file:
                env_file.write(f"TAIPY_GUI_DIR={site_packages_path}\n")
        os.system("cd gui && npm ci && npm run build")


class NPMInstall(build_py):
    def run(self):
        _build_webapp()
        build_py.run(self)


setup(
    author="Avaiga",
    author_email="dev@taipy.io",
    python_requires=">=3.8",
    classifiers=[
        "Intended Audience :: Developers",
        "License :: OSI Approved :: Apache Software License",
        "Natural Language :: English",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
    ],
    description="A 360° open-source platform from Python pilots to production-ready web apps.",
    setup_requires=setup_requirements,
    install_requires=requirements,
    entry_points={
        "console_scripts": [
            "taipy = taipy._entrypoint:_entrypoint",
        ]
    },
    license="Apache License 2.0",
    long_description=readme,
    long_description_content_type="text/markdown",
    keywords="taipy",
    name="taipy",
    package_dir={"": "src"},
    packages=find_namespace_packages(where="src") + find_packages(include=["taipy"]),
    include_package_data=True,
    test_suite="tests",
    url="https://github.com/avaiga/taipy",
    version=version_string,
    zip_safe=False,
    extras_require=extras_require,
    cmdclass={"build_py": NPMInstall},
)