Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 5 KB

README.md

File metadata and controls

95 lines (67 loc) · 5 KB
Raw

Foundry DevTools

Seamlessly run your Palantir Foundry Repository transforms code and more on your local machine. Foundry DevTools is a set of useful libraries to interact with the Foundry APIs. It consists of two parts:

  • The transforms implementation

    • An implementation of the Foundry transforms package that internally uses the CachedFoundryClient. This allows you to seamlessly run your Palantir Foundry Code Repository transforms code on your local machine. Foundry DevTools does not cover all of Foundry's features, more on this here.

  • API clients

    We implemented multiple clients for many foundry APIs like compass, catalog or foundry-sql-server.

    • For example:

      from foundry_dev_tools import FoundryContext

# the context, that contains your credentials and configuration
ctx = FoundryContext()

df = ctx.foundry_sql_server.query_foundry_sql("SELECT * FROM `/Global/Foundry Training and Resources/Example Data/Aviation Ontology/airlines`", branch='master')
df.shape
# Out[2]: (17, 10)

Quickstart

With pip:

pip install foundry-dev-tools

With conda or mamba on the conda-forge channel:

conda install -c conda-forge foundry-dev-tools

Further instructions can be found in our documentation.

Why did we build this?

  • Local development experience in your favorite IDE (PyCharm, VSCode, ...)
    • Access to modern developer tools and workflows such as ruff, mypy, pylint, black, pre-commit hooks etc.
  • Quicker turnaround time when making changes
    • Debug, change code and run in a matter of seconds instead of minutes
  • No accidental or auto commits
    • Keep your git history clean

License

Copyright (c) 2024 Merck KGaA, Darmstadt, Germany

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

https://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 full text of the license can be found in the LICENSE file in the repository root directory.