pysal / submodule_template

This provides a template for submodules to use in the PySAL project
BSD 3-Clause "New" or "Revised" License
2 stars 10 forks source link

readme on pypi #44

Open knaaptime opened 9 months ago

knaaptime commented 9 months ago

i just noticed that with our current tooling, most of the packages lose their READMEs on pypi. spopt still has a full description, but spaghetti, tobler, momepy, spreg all just have a title. It's not the worst thing in the world, but probably an easy fix

martinfleis commented 9 months ago

Yeah, super easy. See https://github.com/martinfleis/clustergram/blob/main/pyproject.toml

martinfleis commented 9 months ago

We just need to ensure we don't use unsupported formatting. Pypi is a bit more restrictive about some characters from what I remember.

knaaptime commented 9 months ago

ah, funny. We just need to specify the readme file in the readme line of toml?

martinfleis commented 9 months ago

Yeah