Skip to content

Commit 554602c

Browse files
committed
clarify metadata info
1 parent cd7b294 commit 554602c

File tree

2 files changed

+7
-10
lines changed

2 files changed

+7
-10
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,12 @@ groups:
8484

8585
<Step title="Add PyPI metadata (optional)">
8686

87-
You can add metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package's PyPI page and includes `keywords` for PyPI search and discovery, `documentation-link` for your package documentation, and `homepage-link` for your project homepage.
87+
You can add publishing metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package's PyPI page and includes `keywords` for PyPI search and discovery, `documentation-link` for your package documentation, and `homepage-link` for your project homepage.
88+
89+
You can additionally add general metadata for the SDK (description, contact email, author, license, etc.) at [the individual SDK level](/learn/sdks/reference/generators-yml#metadata-2) or [globally for all SDKs](/learn/sdks/reference/generators-yml#metadata).
8890

8991

90-
```yaml title="generators.yml" {9-13}
92+
```yaml title="generators.yml" {9, 13}
9193
groups:
9294
python-sdk:
9395
generators:
@@ -96,11 +98,11 @@ groups:
9698
output:
9799
location: pypi
98100
package-name: your-package-name
99-
metadata:
101+
metadata: # Publishing metadata
100102
keywords: ["api", "sdk", "client"]
101103
documentation-link: "https://docs.yourcompany.com"
102104
homepage-link: "https://yourcompany.com"
103-
metadata:
105+
metadata: # General SDK metadata
104106
license: MIT
105107
config:
106108
client_class_name: YourClientName

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: generators.yml configuration schema
33
description: Reference for the generators.yml configuration
4-
max-toc-depth: 2
4+
max-toc-depth: 3
55
---
66

77
The `generators.yml` file configures how Fern generates SDKs from your API
@@ -288,7 +288,6 @@ Package metadata like description and authors that gets included in all generate
288288
```yaml title="generators.yml"
289289
metadata:
290290
description: "My API SDK"
291-
license: MIT
292291
authors:
293292
- name: "John Doe"
294293
@@ -300,10 +299,6 @@ metadata:
300299
A brief description of the SDK that will be included in package metadata. This description helps users understand what your SDK does when they discover it in package repositories.
301300
</ParamField>
302301

303-
<ParamField path="license" type="'MIT' | 'Apache-2.0'" required={false} toc={true}>
304-
Software license for the generated SDK. Supported values are `MIT` or `Apache-2.0`. This populates the license field in package manifests (e.g., `pyproject.toml` for Python, `package.json` for TypeScript).
305-
</ParamField>
306-
307302
### `authors`
308303
A list of authors who will be credited in the generated SDK's package metadata.
309304

0 commit comments

Comments
 (0)