Skip to content

Commit 396b61c

Browse files
Fix Python SDK configuration key from package-name to package_name
The Python SDK configuration uses underscores, not hyphens. Updated: - configuration.mdx: Fixed package-name to package_name in example and ParamField paths - publishing-to-pypi.mdx: Fixed package-name to package_name in all YAML examples Co-Authored-By: [email protected] <[email protected]>
1 parent c9784a8 commit 396b61c

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

fern/products/sdks/overview/python/configuration.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ groups:
1212
- name: fernapi/fern-python
1313
version: <Markdown src="/snippets/version-number-python.mdx"/>
1414
config:
15-
package-name: "your_package"
15+
package_name: "your_package"
1616
client:
1717
class_name: "YourClient"
1818
additional_init_exports:
@@ -117,12 +117,12 @@ When enabled, generates utility methods for working with union types, including
117117
Set to `false` to restore eager loading behavior.
118118
</ParamField>
119119

120-
<ParamField path="package-name" type="string" default="null" required={false} toc={true}>
120+
<ParamField path="package_name" type="string" default="null" required={false} toc={true}>
121121

122122
Specifies the Python package name that users will import your generated client
123123
from.
124124

125-
For example, setting `package-name: "my_custom_package"` enables users to use
125+
For example, setting `package_name: "my_custom_package"` enables users to use
126126
`my_custom_package import Client` to import your client.
127127

128128
</ParamField>
@@ -275,7 +275,7 @@ config:
275275
Enable ORM mode for Pydantic models to work with ORMs like SQLAlchemy.
276276
</ParamField>
277277

278-
<ParamField path="package-name" type="string" required={false} toc={true}>
278+
<ParamField path="package_name" type="string" required={false} toc={true}>
279279
Custom package name for the generated models.
280280
</ParamField>
281281

fern/products/sdks/overview/python/publishing-to-pypi.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ groups:
5757
version: <Markdown src="/snippets/version-number-python.mdx"/>
5858
output:
5959
location: pypi
60-
package-name: your-package-name
60+
package_name: your-package-name
6161
```
6262
6363
</Step>
@@ -75,7 +75,7 @@ groups:
7575
version: <Markdown src="/snippets/version-number-python.mdx"/>
7676
output:
7777
location: pypi
78-
package-name: your-package-name
78+
package_name: your-package-name
7979
config:
8080
client_class_name: YourClientName # must be PascalCase
8181
```
@@ -132,7 +132,7 @@ groups:
132132
version: <Markdown src="/snippets/version-number-python.mdx"/>
133133
output:
134134
location: pypi
135-
package-name: your-package-name
135+
package_name: your-package-name
136136
config:
137137
client_class_name: YourClientName
138138
github:
@@ -152,7 +152,7 @@ groups:
152152
version: <Markdown src="/snippets/version-number-python.mdx"/>
153153
output:
154154
location: pypi
155-
package-name: your-package-name
155+
package_name: your-package-name
156156
token: ${PYPI_TOKEN}
157157
config:
158158
client_class_name: YourClientName
@@ -172,7 +172,7 @@ groups:
172172
version: <Markdown src="/snippets/version-number-python.mdx"/>
173173
output:
174174
location: npm
175-
package-name: name-of-your-package
175+
package_name: name-of-your-package
176176
token: ${PYPI_TOKEN}
177177
config:
178178
namespaceExport: YourClientName
@@ -308,4 +308,4 @@ Set up a CI workflow that you can manually trigger from the GitHub UI. In your r
308308

309309
</Steps>
310310
</Accordion>
311-
</AccordionGroup>
311+
</AccordionGroup>

0 commit comments

Comments
 (0)