Skip to content

Commit 6a3f536

Browse files
nicornkclaude
andcommitted
docs: deprecate transforms implementation and recommend VS Code extension
- Strike through transforms implementation in README - Add notice about Palantir extension for Visual Studio Code - Update transforms API link to current documentation - Update copyright year to 2026 - Remove v2 announcement banner from documentation - Add testing instructions for remote branches Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent a0c7e18 commit 6a3f536

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ Seamlessly run your Palantir Foundry Repository transforms code and more on your
2828
Foundry DevTools is a set of useful libraries to interact with the Foundry APIs.
2929
It consists of two parts:
3030

31-
- The [transforms](https://www.palantir.com/docs/foundry/transforms-python/transforms-python-api/) implementation
31+
- ~~The~~ [~~transforms~~](https://www.palantir.com/docs/foundry/api-reference/transforms-python-library) ~~implementation~~
3232

33-
- An implementation of the Foundry `transforms` package that internally uses the `CachedFoundryClient`.
33+
- ~~An implementation of the Foundry `transforms` package that internally uses the `CachedFoundryClient`.
3434
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).
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+
- The [Palantir extension for Visual Studio Code](https://www.palantir.com/docs/foundry/palantir-extension-for-visual-studio-code/overview/) has achieved the goals of the transforms implementation and should be used instead. The transforms implementation in foundry-dev-tools is no longer maintained.
3637

3738
- API clients
3839

@@ -78,7 +79,7 @@ conda install -c conda-forge foundry-dev-tools
7879

7980
# License
8081

81-
Copyright (c) 2024 Merck KGaA, Darmstadt, Germany
82+
Copyright (c) 2026 Merck KGaA, Darmstadt, Germany
8283

8384
Licensed under the Apache License, Version 2.0 (the "License");
8485
you may not use this file except in compliance with the License.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
html_theme_options = {
121121
"show_navbar_depth": 2,
122122
"show_toc_level": 4,
123-
"announcement":"Note: This is the documentation for Foundry DevTools v2",
123+
"announcement":"Foundry DevTools Documentation",
124124
}
125125

126126
# The name for this set of Sphinx documents. If None, it defaults to

docs/dev/contribute.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,20 @@ Then install foundry-dev-tools and the dev dependencies via:
3939
pdm install
4040
```
4141

42-
4342
This command will link the local version of this package into your pip package folder.
4443
Every change you make in the code is instantly applied.
4544

45+
## Testing a Remote Branch
46+
47+
To test a branch from a remote repository (e.g., from a fork or pull request) without cloning it locally, you can use `uv run`:
48+
49+
```shell
50+
# Test with a specific branch from a GitHub repository
51+
uv run --no-project \
52+
--with 'git+https://github.com/emdgroup/foundry-dev-tools.git@main#subdirectory=libs/foundry-dev-tools' \
53+
python -c "from foundry_dev_tools import __version__; print(__version__)"
54+
```
55+
4656
## Pre-Commit hooks & formatting
4757

4858
To format the code and make it ready for a commit we use pre-commit.

0 commit comments

Comments
 (0)