From 538e97dfd3b88d5b6e82326ab151ead5b0b23aa0 Mon Sep 17 00:00:00 2001 From: Louis Gesbert Date: Wed, 18 Oct 2023 16:57:47 +0200 Subject: [PATCH] Install Python and R runtimes Runtimes for the various backends are expected to be made available from their own ecosystem. However, for convenience and to help with development settings (where the runtime might change), as part of installing catala they are put, in source form, into `/lib/catala/runtime_LANG`. When using a dev version of Catala, and using Python, one would then just have to do `pip install /lib/catala/runtime_python` within their venv to be able to run their python programs. --- Makefile | 18 +- build_system/dune | 3 +- dune-project | 3 + runtimes/dune | 12 +- runtimes/python/README.md | 1 + runtimes/python/catala/.gitignore | 160 ------------------ runtimes/python/catala/pyproject.toml | 3 - runtimes/python/catala/setup.cfg | 18 -- runtimes/python/catala/setup.py | 5 - runtimes/python/pyproject.toml | 33 ++++ .../{catala => }/src/catala/__init__.py | 0 .../python/{catala => }/src/catala/runtime.py | 0 runtimes/r/R/dune | 4 + 13 files changed, 66 insertions(+), 194 deletions(-) create mode 100644 runtimes/python/README.md delete mode 100644 runtimes/python/catala/.gitignore delete mode 100644 runtimes/python/catala/pyproject.toml delete mode 100644 runtimes/python/catala/setup.cfg delete mode 100644 runtimes/python/catala/setup.py create mode 100644 runtimes/python/pyproject.toml rename runtimes/python/{catala => }/src/catala/__init__.py (100%) rename runtimes/python/{catala => }/src/catala/runtime.py (100%) create mode 100644 runtimes/r/R/dune diff --git a/Makefile b/Makefile index f6cbb233..6af87a5f 100644 --- a/Makefile +++ b/Makefile @@ -37,14 +37,14 @@ PY_VENV_ACTIVATE = . $(PY_VENV_DIR)/bin/activate; $(PY_VENV_DIR): $(PY_VENV_DIR)/stamp $(PY_VENV_DIR)/stamp: \ - runtimes/python/catala/pyproject.toml \ + runtimes/python/pyproject.toml \ syntax_highlighting/en/pygments/pyproject.toml \ syntax_highlighting/fr/pygments/pyproject.toml \ syntax_highlighting/pl/pygments/pyproject.toml test -d $(PY_VENV_DIR) || python3 -m venv $(PY_VENV_DIR) $(PY_VENV_ACTIVATE) python3 -m pip install -U pip $(PY_VENV_ACTIVATE) python3 -m pip install -U \ - -e runtimes/python/catala \ + -e runtimes/python \ -e syntax_highlighting/en/pygments \ -e syntax_highlighting/fr/pygments \ -e syntax_highlighting/pl/pygments @@ -52,10 +52,18 @@ $(PY_VENV_DIR)/stamp: \ dependencies-python: $(PY_VENV_DIR) -#> dependencies : Install the Catala OCaml, JS and Git dependencies -dependencies: dependencies-ocaml dependencies-js dependencies-python +build-runtime-python: dependencies-python + $(PY_VENV_ACTIVATE) python3 -m pip install -U build + $(PY_VENV_ACTIVATE) python -m build runtimes/python -o _build/python-runtime/ -dependencies-with-z3: dependencies-ocaml-with-z3 dependencies-js dependencies-python +publish-runtime-python: + $(PY_VENV_ACTIVATE) python3 -m pip install -U twine + $(PY_VENV_ACTIVATE) python -m twine upload _build/python-runtime/* + +#> dependencies : Install the Catala OCaml, JS and Git dependencies +dependencies: dependencies-ocaml dependencies-python + +dependencies-with-z3: dependencies-ocaml-with-z3 dependencies-python ########################################## # Catala compiler rules diff --git a/build_system/dune b/build_system/dune index 75d3fa4b..cc515c2b 100644 --- a/build_system/dune +++ b/build_system/dune @@ -26,8 +26,7 @@ (:standard (:include custom_linking.sexp))) (libraries clerk_driver) - (link_deps - (package catala)) + (link_deps ../compiler/catala.exe) ; not a real dependency, but when running clerk in practice you always want the catala binary to be up-to-date (e.g. `dune exec -- ckerk test`) (modules clerk) (package catala)) diff --git a/dune-project b/dune-project index 7b5c6ea7..b6000e52 100644 --- a/dune-project +++ b/dune-project @@ -6,6 +6,8 @@ (formatting) +(subst disabled) + (source (uri git+https://github.com/CatalaLang/catala.git)) @@ -27,3 +29,4 @@ (license Apache-2.0) (using menhir 2.1) +(using directory-targets 0.1) diff --git a/runtimes/dune b/runtimes/dune index bcf2d146..5fbfba5d 100644 --- a/runtimes/dune +++ b/runtimes/dune @@ -1,4 +1,14 @@ (documentation (package catala)) -(dirs jsoo ocaml python) +(dirs jsoo ocaml python r) + +; Installation is done as source under catala lib directory +; For dev version this makes it easy to install the proper runtime with just +; `pip install dir` and be sure to get the right version + +; Python runtime +(install + (files + (glob_files_rec (python/** with_prefix runtime_python))) + (section lib)) diff --git a/runtimes/python/README.md b/runtimes/python/README.md new file mode 100644 index 00000000..19861a70 --- /dev/null +++ b/runtimes/python/README.md @@ -0,0 +1 @@ +This is the Catala runtime, that is required by programs compiled to Python by Catala. diff --git a/runtimes/python/catala/.gitignore b/runtimes/python/catala/.gitignore deleted file mode 100644 index 68bc17f9..00000000 --- a/runtimes/python/catala/.gitignore +++ /dev/null @@ -1,160 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# poetry -# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. -# This is especially recommended for binary packages to ensure reproducibility, and is more -# commonly ignored for libraries. -# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control -#poetry.lock - -# pdm -# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. -#pdm.lock -# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it -# in version control. -# https://pdm.fming.dev/#use-with-ide -.pdm.toml - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# PyCharm -# JetBrains specific template is maintained in a separate JetBrains.gitignore that can -# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore -# and can be added to the global gitignore or merged into this file. For a more nuclear -# option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ diff --git a/runtimes/python/catala/pyproject.toml b/runtimes/python/catala/pyproject.toml deleted file mode 100644 index cc6f2c6e..00000000 --- a/runtimes/python/catala/pyproject.toml +++ /dev/null @@ -1,3 +0,0 @@ -[build-system] -requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"] -build-backend = "setuptools.build_meta" diff --git a/runtimes/python/catala/setup.cfg b/runtimes/python/catala/setup.cfg deleted file mode 100644 index 2ab46098..00000000 --- a/runtimes/python/catala/setup.cfg +++ /dev/null @@ -1,18 +0,0 @@ -[metadata] -name = catala-runtime -platforms = any - -[options] -install_requires = - gmpy2 - typing - mypy - python-dateutil - types-python-dateutil - autopep8 - termcolor - types-termcolor -[options.extras_require] -test = - pytest - pytest-cov diff --git a/runtimes/python/catala/setup.py b/runtimes/python/catala/setup.py deleted file mode 100644 index 90d4e0d6..00000000 --- a/runtimes/python/catala/setup.py +++ /dev/null @@ -1,5 +0,0 @@ -from setuptools import setup # type: ignore - -setup(package_data={ - 'catala-runtime': ['py.typed'], -},) diff --git a/runtimes/python/pyproject.toml b/runtimes/python/pyproject.toml new file mode 100644 index 00000000..22fff8c2 --- /dev/null +++ b/runtimes/python/pyproject.toml @@ -0,0 +1,33 @@ +[project] +name = "catala-runtime" +description = "Runtime libraries needed to execute Catala programs compiled to Python" +version = "0.9.0" +dependencies = [ + "gmpy2", + "typing", + "mypy", + "python-dateutil", + "types-python-dateutil", + "autopep8", + "termcolor", + "types-termcolor", + "typer[all]", + "typing-extensions" +] + +[project.optional-dependencies] +test = [ + "pytest", + "pytest-cov", +] + +[project.urls] +"Homepage" = "https://github.com/CatalaLang/catala/" +"Bug Tracker" = "https://github.com/CatalaLang/catala/issues" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.hatch.build.targets.wheel] +packages = ["src/catala"] diff --git a/runtimes/python/catala/src/catala/__init__.py b/runtimes/python/src/catala/__init__.py similarity index 100% rename from runtimes/python/catala/src/catala/__init__.py rename to runtimes/python/src/catala/__init__.py diff --git a/runtimes/python/catala/src/catala/runtime.py b/runtimes/python/src/catala/runtime.py similarity index 100% rename from runtimes/python/catala/src/catala/runtime.py rename to runtimes/python/src/catala/runtime.py diff --git a/runtimes/r/R/dune b/runtimes/r/R/dune new file mode 100644 index 00000000..4da0b64c --- /dev/null +++ b/runtimes/r/R/dune @@ -0,0 +1,4 @@ +(install + (section lib) + (files + (runtime.R as runtime_r/runtime.R)))