Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Add PyPI metadata configuration to Python publishing documentation

Summary

Added documentation for optional PyPI metadata configuration in the Python SDK publishing guide. This addresses the request to include PyPI project metadata information from the generators.yml reference page, enabling users to configure keywords, documentation links, and homepage links that appear on their PyPI package page.

The new section is added as an optional step in the "Configure SDK package settings" section, showing users how to add the metadata object with keywords, documentation-link, and homepage-link fields.

Review & Testing Checklist for Human

  • Verify the placement of the new "Add PyPI metadata (optional)" step makes sense in the documentation flow (currently positioned after client-class-name configuration)
  • Test the YAML example by generating a Python SDK with the metadata fields to confirm they work as documented
  • Review whether any other PyPI-specific configuration from the generators.yml reference should be included (I focused on the metadata fields; there are also alternative authentication methods like username/password that weren't added)

Notes

  • Successfully tested locally with fern docs dev - the documentation builds without errors
  • The metadata fields (keywords, documentation-link, homepage-link) match exactly what's documented in the generators.yml reference page
  • This addresses the Slack thread request to help users set up PyPI project metadata like in the screenshot example

Link to Devin run: https://app.devin.ai/sessions/8a8fa4cd9b6b4d5fa7f5005a567975e5
Requested by: adi@buildwithfern.com (@aditya-arolkar-swe)

Co-Authored-By: adi@buildwithfern.com <aditya.arolkar@berkeley.edu>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

@aditya-arolkar-swe aditya-arolkar-swe self-requested a review October 29, 2025 23:35
@aditya-arolkar-swe aditya-arolkar-swe merged commit 2bcbce2 into main Oct 29, 2025
2 checks passed
@aditya-arolkar-swe aditya-arolkar-swe deleted the devin/1761780744-add-pypi-metadata-docs branch October 29, 2025 23:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants