Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion fern/products/sdks/overview/python/publishing-to-pypi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ groups:
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.


```yaml title="generators.yml" {9-12}
```yaml title="generators.yml" {9-13}
groups:
python-sdk:
generators:
Expand All @@ -100,6 +100,8 @@ groups:
keywords: ["api", "sdk", "client"]
documentation-link: "https://docs.yourcompany.com"
homepage-link: "https://yourcompany.com"
metadata:
license: MIT
config:
client_class_name: YourClientName
```
Expand Down
5 changes: 5 additions & 0 deletions fern/products/sdks/reference/generators-yml-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ Package metadata like description and authors that gets included in all generate
```yaml title="generators.yml"
metadata:
description: "My API SDK"
license: MIT
authors:
- name: "John Doe"
email: "[email protected]"
Expand All @@ -299,6 +300,10 @@ metadata:
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.
</ParamField>

<ParamField path="license" type="'MIT' | 'Apache-2.0'" required={false} toc={true}>
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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'MIT' has no definition.

</ParamField>

### `authors`
A list of authors who will be credited in the generated SDK's package metadata.

Expand Down
Loading