Skip to content

V1 Release #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3,916 changes: 1,593 additions & 2,323 deletions README.md

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions changelog/@unreleased/pr-180.v2.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
type: break
break:
description: "### Migration Guide\n- The top level module was renamed from `foundry` to `foundry_sdk` to
resolve a name collision with the `foundry` package. This means that all imports
will need to be updated. For example, the following import:\n\n```python\nfrom
foundry import FoundryClient\n```\n\nwill need to be updated to:\n\n```python\nfrom
foundry_sdk import FoundryClient\n```\n
\n- The deprecated `page` operations have been
removed in favor of the `list` operations. If you were still using the `page`
methods, you can switch them to `list` instead.\n\n```python\npage = client.datasets.Dataset.Branch.page(dataset_rid,
page_size=page_size) # before\npage = client.datasets.Dataset.Branch.list(dataset_rid,
page_size=page_size) # after\n```\n\n- The method definitions no longer include
`TypeDict` types for complex objects. Instead, only the pydantic `BaseModel` classes
will be included in the method definition. Python dictionaries can continue to
be passed into these methods; however, mypy/pyright type checking will start to
error if you use dictionaries.\n\n```python\n# before\nclass ScheduleClient:\n
\ ...\n \n def create(\n self,\n *,\n action: typing.Union[CreateScheduleRequestAction,
CreateScheduleRequestActionDict],\n ...\n ) -> Schedule:\n \n# after\nclass
ScheduleClient:\n ...\n \n def create(\n self,\n *,\n action:
CreateScheduleRequestAction,\n ...\n ) -> Schedule:\n```\n\n- Typing
support has also been removed from the `to_dict()` methods on the base classes.
Support may be added back in the future if there are use cases for having typing
support.\n\n```python\n# before\nclass Schedule(BaseModel):\n ...\n\n def
to_dict(self) -> \"ScheduleDict\":\n \"\"\"Return the dictionary representation
of the model using the field aliases.\"\"\"\n return typing.cast(ScheduleDict,
self.model_dump(by_alias=True, exclude_none=True))\n\n# after\nclass Schedule(BaseModel):\n
\ ...\n\n def to_dict(self) -> Dict[str, Any]:\n \"\"\"Return the
dictionary representation of the model using the field aliases.\"\"\"\n return
self.model_dump(by_alias=True, exclude_none=True)\n```\n\n- The deprecated `sign_in_as_service_user`
method was removed `ConfidentialClientAuth`. The `get_token` method can be used
instead.\n- The deprecated `page_iterator` property from `ResourceIterator` was
removed. Instead, the `data` and `next_page_token` properties can be accessed
directly from the `ResourceIterator` class.\n- The deprecated `hostname` parameter
was removed from the `UserTokenAuth` class and `token` was made a positional
argument."
links:
- https://github.com/palantir/foundry-platform-python/pull/180
3 changes: 2 additions & 1 deletion config.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"packageName": "foundry",
"packageName": "foundry_sdk",
"packageUrl": "https://github.com/palantir/foundry-platform-python",
"projectName": "foundry-platform-sdk",
"clientName": "FoundryClient",
"platformName": "Foundry",
"userHeader": "python-foundry-platform-sdk",
"description": "The official Python library for the Foundry API",
"promotedMajorVersion": "v2",
"documentationBaseUrl": "https://palantir.com",
"extraDocsDir": "assets/docs_examples",
"exampleOperation": {
"majorVersion": "v2",
Expand Down
11 changes: 0 additions & 11 deletions docs/v1/Core/models/AnyTypeDict.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AttachmentTypeDict
# AttachmentType

AttachmentType

Expand Down
11 changes: 0 additions & 11 deletions docs/v1/Core/models/BinaryTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/BooleanTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/ByteTypeDict.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/v1/Core/models/CipherTextTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/DateTypeDict.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/v1/Core/models/DecimalTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/DoubleTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/FloatTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/IntegerTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/LongTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/MarkingTypeDict.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NullTypeDict
# NullType

NullType

Expand Down
11 changes: 0 additions & 11 deletions docs/v1/Core/models/ShortTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/StringTypeDict.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/v1/Core/models/TimestampTypeDict.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/v1/Core/models/UnsupportedTypeDict.md

This file was deleted.

Loading