Preparing `rsxml` module for PyPi deployment
MattReimer opened this issue · 1 comments
MattReimer commented
In order to publish our rsxml
we need our best foot forward. That includes metadata, help, readmes etc.
Here's what we need:
- A good Readme: Introduction. why you need this, installation, basic usage, where to go for help, link to examples folder in the repo.
- A
CHANGELIST.md
file we link to from the readme. It can be empty to start. - Need a LICENSE file. MIT license is probably fine.
- Improvements to metadata (
pyproject.toml
andsetup.py
) (see docs) - More python examples (especially for the XML writing stuff)
- Better comments on examples to let people know why we're doing every step.
- Different use cases: (i.e. here's how you create a NEW xml, here's how you update an existing one)
- A thought to versioning. What version should we start with?
- @philipbaileynar please make a PyPi account so that I can add you to the project
Resources
A good example of a package the looks good are:
- https://pypi.org/project/morecantile/
- https://pypi.org/project/convertbng/
- https://pypi.org/project/actinia-core/
You can probably steal a lot of config and ideas from them.
MattReimer commented
Looks good. Thanks for doing this.