Skip to content

Author Readme files for each library and integrate into the PyPi descriptions. Fixes #156 - #157

Merged
Chris Mullins (cleemullins) merged 12 commits into
mainfrom
Libary-Readmes-and-PyPi-Description-Setup
Oct 13, 2025
Merged

Author Readme files for each library and integrate into the PyPi descriptions. Fixes #156#157
Chris Mullins (cleemullins) merged 12 commits into
mainfrom
Libary-Readmes-and-PyPi-Description-Setup

Conversation

@cleemullins

@cleemullins Chris Mullins (cleemullins) commented Oct 8, 2025

Copy link
Copy Markdown
Contributor

Fixes #156

Following guidance found on Python Packaging

This means:

  • Added a new readme.md file for each package
  • Added the readme contents to the package via the .toml file, per current guidance in the Python world.

As we move forward, updating the package descriptions is just a change to the relevant readme files.

…g descriptions. Those descriptions should show up in PyPi. This is following thie guidance found on Python Packaging here: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/
…in pyproject.toml for PyPi compatibility

Lean into the newer PEP 621 metadata approach we're already using, rather than using the older long_description approach.
…ve SDK descriptions, package overviews, and sample application links for improved developer guidance.
@tracyboehrer

Copy link
Copy Markdown
Member

Chris Mullins (@cleemullins) Food for thought, not a no... I had originally played with providing sample code in these README's, then decided it was a doc maintenance problem. What about just links to Learn documents so that samples (etc) is in one place?

@cleemullins

Copy link
Copy Markdown
Contributor Author

I had originally played with providing sample code in these README's, then decided it was a doc maintenance problem.

Reasonable, but the samples (and really all the readme) is generated by an LLM on analysis of our repo. There's no hand-rolled samples or code in there.

Now, if we were spiffy, we would auto generate the entire readme from a template on each merge to main. Using a readme.md template, this seems practical. I started going down that route, but would have spent more time doing that (by far) than just using a prompt and generating them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There is a lot of code here, and this is a more accessible (more visible) source of examples than even our samples. For that reason, I think we should treat the code examples here the same. If we are going to provide this much code in our READMEs on PyPI, then I would make sure it's well tested. I haven't looked through all of the READMEs to save time because it also don't feel right to verify this code via inspection alone.

Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-authentication-msal/readme.md
Comment thread libraries/microsoft-agents-authentication-msal/readme.md Outdated
Comment thread libraries/microsoft-agents-hosting-teams/readme.md
@cleemullins
Chris Mullins (cleemullins) merged commit 629dd48 into main Oct 13, 2025
7 of 8 checks passed
@cleemullins
Chris Mullins (cleemullins) deleted the Libary-Readmes-and-PyPi-Description-Setup branch October 13, 2025 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Published PyPi Packages lack descriptions

3 participants