Skip to content

Commit 2bcbce2

Browse files
Add PyPI metadata configuration to Python publishing documentation (#1594)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]>
1 parent efa5671 commit 2bcbce2

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,30 @@ groups:
8181
```
8282
8383
</Step>
84+
85+
<Step title="Add PyPI metadata (optional)">
86+
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.
88+
89+
90+
```yaml title="generators.yml" {9-12}
91+
groups:
92+
python-sdk:
93+
generators:
94+
- name: fernapi/fern-python-sdk
95+
version: <Markdown src="/snippets/version-number-python.mdx"/>
96+
output:
97+
location: pypi
98+
package-name: your-package-name
99+
metadata:
100+
keywords: ["api", "sdk", "client"]
101+
documentation-link: "https://docs.yourcompany.com"
102+
homepage-link: "https://yourcompany.com"
103+
config:
104+
client_class_name: YourClientName
105+
```
106+
107+
</Step>
84108
</Steps>
85109

86110
## Generate a PyPi token

0 commit comments

Comments
 (0)