Skip to content

docs: publish project documentation on PyPI - #193

Merged
polsala merged 1 commit into
masterfrom
docs/issue-191-pypi
Oct 7, 2026
Merged

polsala merged 1 commit into
masterfrom
docs/issue-191-pypi

Conversation

@giscebot

@giscebot giscebot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • rewrites the README around the current sastre workflows, including installation, GitHub/SSH authentication, local and remote deployment, patch and diff modes, command reference, tests, and project links
  • publishes that README as PyPI's Markdown long description and adds package URLs, classifiers, and supported Python metadata
  • explicitly includes the README and MIT license in source distributions and validates the built artifacts with twine check before release uploads

Validation

  • python -m unittest discover -s tests on Python 3.11 (54 tests)
  • python setup.py sdist bdist_wheel on Python 3.11 and Python 2.7
  • python -m twine check dist/*
  • inspected wheel and sdist contents for README, license, and Markdown metadata

Closes #191.

Requested by: @polsala

Co-authored-by: polsala <15796004+polsala@users.noreply.github.com>
@polsala polsala added the patch Patch auto version V_._.X label Oct 7, 2026
@polsala
polsala merged commit fa12910 into master Oct 7, 2026
2 checks passed
@polsala
polsala deleted the docs/issue-191-pypi branch October 7, 2026 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

patch Patch auto version V_._.X

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Actualitzar la documentació i mostrar-la correctament a PyPI

2 participants