foundry-dev-tools-transforms 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,125 @@
1
+ Metadata-Version: 2.1
2
+ Name: foundry-dev-tools-transforms
3
+ Version: 2.0.0
4
+ Summary: Seamlessly run your Palantir Foundry Repository transforms code on your local machine.
5
+ Author-Email: Nicolas Renkamp <nicolas.renkamp@merckgroup.com>, Jonas Wunderlich <jonas.wunderlich@merckgroup.com>
6
+ License: Apache-2.0
7
+ Classifier: Development Status :: 5 - Production/Stable
8
+ Classifier: Programming Language :: Python
9
+ Classifier: License :: OSI Approved :: Apache Software License
10
+ Classifier: Programming Language :: Python :: 3 :: Only
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Operating System :: POSIX :: Linux
15
+ Classifier: Operating System :: MacOS
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Classifier: Topic :: Scientific/Engineering :: Information Analysis
18
+ Project-URL: Homepage, https://emdgroup.github.io/foundry-dev-tools
19
+ Project-URL: Documentation, https://emdgroup.github.io/foundry-dev-tools
20
+ Project-URL: Source, https://github.com/emdgroup/foundry-dev-tools
21
+ Project-URL: Tracker, https://github.com/emdgroup/foundry-dev-tools/issues
22
+ Project-URL: Changelog, https://emdgroup.github.io/foundry-dev-tools/changelog.html
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: foundry-dev-tools
25
+ Requires-Dist: typing_extensions; python_version < "3.11"
26
+ Requires-Dist: pyspark>=3.0.0
27
+ Requires-Dist: numpy<2
28
+ Requires-Dist: fs
29
+ Description-Content-Type: text/markdown
30
+
31
+ <div align="center">
32
+ <br/>
33
+
34
+ <a href="https://github.com/emdgroup/foundry-dev-tools/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/emdgroup/foundry-dev-tools/ci.yml?style=flat-square"/></img>
35
+ <a href="https://github.com/emdgroup/foundry-dev-tools/actions/workflows/docs.yml"><img src="https://img.shields.io/github/actions/workflow/status/emdgroup/foundry-dev-tools/docs.yml?style=flat-square"/></img>
36
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/pyversions/foundry-dev-tools?style=flat-square&label=Supported%20Python%20versions&color=%23ffb86c"/></a>
37
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/v/foundry-dev-tools.svg?style=flat-square&label=PyPI%20version&color=%23bd93f9"/></a>
38
+ <a href="https://anaconda.org/conda-forge/foundry-dev-tools"><img src="https://img.shields.io/conda/vn/conda-forge/foundry-dev-tools.svg?style=flat-square&label=Conda%20Forge%20Version&color=%23bd93f9" alt="Conda Version"/></a>
39
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/dm/foundry-dev-tools?label=PyPI%20Downloads&style=flat-square&color=%236272a4"/></a>
40
+ <a href="https://anaconda.org/conda-forge/foundry-dev-tools"><img src="https://img.shields.io/conda/dn/conda-forge/foundry-dev-tools.svg?style=flat-square&label=Conda%20Forge%20Downloads&color=%236272a4" alt="Conda Downloads"/></a>
41
+ <a href="https://github.com/emdgroup/foundry-dev-tools/issues"><img src="https://img.shields.io/github/issues/emdgroup/foundry-dev-tools?style=flat-square&color=%23ff79c6"/></a>
42
+ <a href="https://github.com/emdgroup/foundry-dev-tools/pulls"><img src="https://img.shields.io/github/issues-pr/emdgroup/foundry-dev-tools?style=flat-square&color=%23ff79c6"/></a>
43
+ <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://shields.io/badge/License-Apache%202.0-green.svg?style=flat-square&color=%234c1"/></a>
44
+
45
+ <p><a href="https://emdgroup.github.io/foundry-dev-tools">Documentation</a></p>
46
+
47
+ <a href="https://emdgroup.github.io/foundry-dev-tools/getting_started/index.html">Getting Started / Usage<a/>
48
+ &nbsp;•&nbsp;
49
+ <a href="https://emdgroup.github.io/foundry-dev-tools/examples/api.html">Examples<a/>
50
+ &nbsp;•&nbsp;
51
+ <a href="https://emdgroup.github.io/foundry-dev-tools/dev/contribute.html">Development/Contribute<a/>
52
+
53
+ </div>
54
+
55
+ # Foundry DevTools
56
+
57
+ Seamlessly run your Palantir Foundry Repository transforms code and more on your local machine.
58
+ Foundry DevTools is a set of useful libraries to interact with the Foundry APIs.
59
+ It consists of two parts:
60
+
61
+ - The [transforms](https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api/) implementation
62
+
63
+ - An implementation of the Foundry `transforms` package that internally uses the `CachedFoundryClient`.
64
+ This allows you to seamlessly run your Palantir Foundry Code Repository transforms code on your local machine.
65
+ Foundry DevTools does not cover all of Foundry's features, more on this [here](https://emdgroup.github.io/foundry-dev-tools/dev/architecture.html#known-limitations-contributions-welcome).
66
+
67
+ - API clients
68
+
69
+ We implemented multiple clients for many foundry APIs like compass, catalog or foundry-sql-server.
70
+
71
+ - For example:
72
+
73
+ ```python
74
+ from foundry_dev_tools import FoundryContext
75
+
76
+ # the context, that contains your credentials and configuration
77
+ ctx = FoundryContext()
78
+
79
+ df = ctx.foundry_sql_server.query_foundry_sql("SELECT * FROM `/Global/Foundry Training and Resources/Example Data/Aviation Ontology/airlines`", branch='master')
80
+ df.shape
81
+ # Out[2]: (17, 10)
82
+ ```
83
+
84
+ ## Quickstart
85
+
86
+ With pip:
87
+
88
+ ```shell
89
+ pip install foundry-dev-tools
90
+ ```
91
+
92
+ With conda or mamba on the conda-forge channel:
93
+
94
+ ```shell
95
+ conda install -c conda-forge foundry-dev-tools
96
+ ```
97
+
98
+ [Further instructions](https://emdgroup.github.io/foundry-dev-tools/getting_started/installation.html) can be found in our documentation.
99
+
100
+ ## Why did we build this?
101
+
102
+ - Local development experience in your favorite IDE (PyCharm, VSCode, ...)
103
+ - Access to modern developer tools and workflows such as ruff, mypy, pylint, black, pre-commit hooks etc.
104
+ - Quicker turnaround time when making changes
105
+ - Debug, change code and run in a matter of seconds instead of minutes
106
+ - No accidental or auto commits
107
+ - Keep your git history clean
108
+
109
+ # License
110
+
111
+ Copyright (c) 2024 Merck KGaA, Darmstadt, Germany
112
+
113
+ Licensed under the Apache License, Version 2.0 (the "License");
114
+ you may not use this file except in compliance with the License.
115
+ You may obtain a copy of the License at
116
+
117
+ https://www.apache.org/licenses/LICENSE-2.0
118
+
119
+ Unless required by applicable law or agreed to in writing, software
120
+ distributed under the License is distributed on an "AS IS" BASIS,
121
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
122
+ See the License for the specific language governing permissions and
123
+ limitations under the License.
124
+
125
+ The full text of the license can be found in the [LICENSE](https://github.com/emdgroup/foundry-dev-tools/blob/main/LICENSE) file in the repository root directory.
@@ -0,0 +1,95 @@
1
+ <div align="center">
2
+ <br/>
3
+
4
+ <a href="https://github.com/emdgroup/foundry-dev-tools/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/emdgroup/foundry-dev-tools/ci.yml?style=flat-square"/></img>
5
+ <a href="https://github.com/emdgroup/foundry-dev-tools/actions/workflows/docs.yml"><img src="https://img.shields.io/github/actions/workflow/status/emdgroup/foundry-dev-tools/docs.yml?style=flat-square"/></img>
6
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/pyversions/foundry-dev-tools?style=flat-square&label=Supported%20Python%20versions&color=%23ffb86c"/></a>
7
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/v/foundry-dev-tools.svg?style=flat-square&label=PyPI%20version&color=%23bd93f9"/></a>
8
+ <a href="https://anaconda.org/conda-forge/foundry-dev-tools"><img src="https://img.shields.io/conda/vn/conda-forge/foundry-dev-tools.svg?style=flat-square&label=Conda%20Forge%20Version&color=%23bd93f9" alt="Conda Version"/></a>
9
+ <a href="https://pypi.org/project/foundry-dev-tools/"><img src="https://img.shields.io/pypi/dm/foundry-dev-tools?label=PyPI%20Downloads&style=flat-square&color=%236272a4"/></a>
10
+ <a href="https://anaconda.org/conda-forge/foundry-dev-tools"><img src="https://img.shields.io/conda/dn/conda-forge/foundry-dev-tools.svg?style=flat-square&label=Conda%20Forge%20Downloads&color=%236272a4" alt="Conda Downloads"/></a>
11
+ <a href="https://github.com/emdgroup/foundry-dev-tools/issues"><img src="https://img.shields.io/github/issues/emdgroup/foundry-dev-tools?style=flat-square&color=%23ff79c6"/></a>
12
+ <a href="https://github.com/emdgroup/foundry-dev-tools/pulls"><img src="https://img.shields.io/github/issues-pr/emdgroup/foundry-dev-tools?style=flat-square&color=%23ff79c6"/></a>
13
+ <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://shields.io/badge/License-Apache%202.0-green.svg?style=flat-square&color=%234c1"/></a>
14
+
15
+ <p><a href="https://emdgroup.github.io/foundry-dev-tools">Documentation</a></p>
16
+
17
+ <a href="https://emdgroup.github.io/foundry-dev-tools/getting_started/index.html">Getting Started / Usage<a/>
18
+ &nbsp;•&nbsp;
19
+ <a href="https://emdgroup.github.io/foundry-dev-tools/examples/api.html">Examples<a/>
20
+ &nbsp;•&nbsp;
21
+ <a href="https://emdgroup.github.io/foundry-dev-tools/dev/contribute.html">Development/Contribute<a/>
22
+
23
+ </div>
24
+
25
+ # Foundry DevTools
26
+
27
+ Seamlessly run your Palantir Foundry Repository transforms code and more on your local machine.
28
+ Foundry DevTools is a set of useful libraries to interact with the Foundry APIs.
29
+ It consists of two parts:
30
+
31
+ - The [transforms](https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api/) implementation
32
+
33
+ - An implementation of the Foundry `transforms` package that internally uses the `CachedFoundryClient`.
34
+ This allows you to seamlessly run your Palantir Foundry Code Repository transforms code on your local machine.
35
+ Foundry DevTools does not cover all of Foundry's features, more on this [here](https://emdgroup.github.io/foundry-dev-tools/dev/architecture.html#known-limitations-contributions-welcome).
36
+
37
+ - API clients
38
+
39
+ We implemented multiple clients for many foundry APIs like compass, catalog or foundry-sql-server.
40
+
41
+ - For example:
42
+
43
+ ```python
44
+ from foundry_dev_tools import FoundryContext
45
+
46
+ # the context, that contains your credentials and configuration
47
+ ctx = FoundryContext()
48
+
49
+ df = ctx.foundry_sql_server.query_foundry_sql("SELECT * FROM `/Global/Foundry Training and Resources/Example Data/Aviation Ontology/airlines`", branch='master')
50
+ df.shape
51
+ # Out[2]: (17, 10)
52
+ ```
53
+
54
+ ## Quickstart
55
+
56
+ With pip:
57
+
58
+ ```shell
59
+ pip install foundry-dev-tools
60
+ ```
61
+
62
+ With conda or mamba on the conda-forge channel:
63
+
64
+ ```shell
65
+ conda install -c conda-forge foundry-dev-tools
66
+ ```
67
+
68
+ [Further instructions](https://emdgroup.github.io/foundry-dev-tools/getting_started/installation.html) can be found in our documentation.
69
+
70
+ ## Why did we build this?
71
+
72
+ - Local development experience in your favorite IDE (PyCharm, VSCode, ...)
73
+ - Access to modern developer tools and workflows such as ruff, mypy, pylint, black, pre-commit hooks etc.
74
+ - Quicker turnaround time when making changes
75
+ - Debug, change code and run in a matter of seconds instead of minutes
76
+ - No accidental or auto commits
77
+ - Keep your git history clean
78
+
79
+ # License
80
+
81
+ Copyright (c) 2024 Merck KGaA, Darmstadt, Germany
82
+
83
+ Licensed under the Apache License, Version 2.0 (the "License");
84
+ you may not use this file except in compliance with the License.
85
+ You may obtain a copy of the License at
86
+
87
+ https://www.apache.org/licenses/LICENSE-2.0
88
+
89
+ Unless required by applicable law or agreed to in writing, software
90
+ distributed under the License is distributed on an "AS IS" BASIS,
91
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
92
+ See the License for the specific language governing permissions and
93
+ limitations under the License.
94
+
95
+ The full text of the license can be found in the [LICENSE](https://github.com/emdgroup/foundry-dev-tools/blob/main/LICENSE) file in the repository root directory.
@@ -0,0 +1,55 @@
1
+ [build-system]
2
+ requires = [
3
+ "pdm-backend",
4
+ ]
5
+ build-backend = "pdm.backend"
6
+
7
+ [project]
8
+ name = "foundry-dev-tools-transforms"
9
+ readme = "README.md"
10
+ description = "Seamlessly run your Palantir Foundry Repository transforms code on your local machine."
11
+ requires-python = ">=3.10"
12
+ authors = [
13
+ { name = "Nicolas Renkamp", email = "nicolas.renkamp@merckgroup.com" },
14
+ { name = "Jonas Wunderlich", email = "jonas.wunderlich@merckgroup.com" },
15
+ ]
16
+ classifiers = [
17
+ "Development Status :: 5 - Production/Stable",
18
+ "Programming Language :: Python",
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Programming Language :: Python :: 3 :: Only",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Intended Audience :: Developers",
24
+ "Operating System :: POSIX :: Linux",
25
+ "Operating System :: MacOS",
26
+ "Operating System :: Microsoft :: Windows",
27
+ "Topic :: Scientific/Engineering :: Information Analysis",
28
+ ]
29
+ dependencies = [
30
+ "foundry-dev-tools",
31
+ "typing_extensions; python_version < \"3.11\"",
32
+ "pyspark>=3.0.0",
33
+ "numpy<2",
34
+ "fs",
35
+ ]
36
+ dynamic = []
37
+ version = "2.0.0"
38
+
39
+ [project.license]
40
+ text = "Apache-2.0"
41
+
42
+ [project.urls]
43
+ Homepage = "https://emdgroup.github.io/foundry-dev-tools"
44
+ Documentation = "https://emdgroup.github.io/foundry-dev-tools"
45
+ Source = "https://github.com/emdgroup/foundry-dev-tools"
46
+ Tracker = "https://github.com/emdgroup/foundry-dev-tools/issues"
47
+ Changelog = "https://emdgroup.github.io/foundry-dev-tools/changelog.html"
48
+
49
+ [tool.pdm]
50
+ distribution = true
51
+
52
+ [tool.pdm.version]
53
+ source = "scm"
54
+ write_to = "transforms/__about__.py"
55
+ write_template = "__version__ = '{}'"
@@ -0,0 +1 @@
1
+ __version__ = '2.0.0'
@@ -0,0 +1,5 @@
1
+ """The transforms module is a stub for the Foundry API."""
2
+
3
+ from transforms.__about__ import __version__
4
+
5
+ __all__ = ["__version__"]
@@ -0,0 +1,33 @@
1
+ """The exposed Function definitions and docstrings is Copyright © 2023 Palantir Technologies Inc. and/or affiliates (“Palantir”). All rights reserved.
2
+
3
+ https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api/
4
+ https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api-classes/
5
+
6
+ """ # noqa: E501
7
+
8
+ from transforms.api._configure import configure
9
+ from transforms.api._dataset import Input, Markings, OrgMarkings, Output
10
+ from transforms.api._decorators import (
11
+ incremental,
12
+ lightweight,
13
+ transform,
14
+ transform_df,
15
+ transform_pandas,
16
+ transform_polars,
17
+ )
18
+ from transforms.api._transform import TransformContext
19
+
20
+ __all__ = (
21
+ "Input",
22
+ "Output",
23
+ "Markings",
24
+ "OrgMarkings",
25
+ "transform_df",
26
+ "transform_pandas",
27
+ "transform",
28
+ "lightweight",
29
+ "transform_polars",
30
+ "TransformContext",
31
+ "incremental",
32
+ "configure",
33
+ )
@@ -0,0 +1,27 @@
1
+ """The exposed Function definitions and docstrings is Copyright © 2023 Palantir Technologies Inc. and/or affiliates (“Palantir”). All rights reserved.
2
+
3
+ https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api/
4
+ https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api-classes/
5
+
6
+ """ # noqa: E501
7
+
8
+ import warnings
9
+ from collections.abc import Callable
10
+
11
+
12
+ def configure(*args, **kwargs) -> Callable: # noqa: ARG001
13
+ """Not implemented in local.
14
+
15
+ Args:
16
+ args: unused
17
+ kwargs: unused
18
+
19
+ Returns:
20
+ the compute_func
21
+ """
22
+ warnings.warn("@configure functionality not implemented in Foundry DevTools")
23
+
24
+ def _configure(compute_func: Callable) -> Callable:
25
+ return compute_func
26
+
27
+ return _configure