Skip to content

Update installation instructions to reflect PyPI availability#57

Merged
simonprovost merged 2 commits intomainfrom
doc_pip_install
May 21, 2025
Merged

Update installation instructions to reflect PyPI availability#57
simonprovost merged 2 commits intomainfrom
doc_pip_install

Conversation

@soniacq
Copy link
Contributor

@soniacq soniacq commented May 21, 2025

  • Revised installation steps in README.md, CONTRIBUTING.md, and the installation guide to reflect UrbanMapper's availability on PyPI, including clearer environment setup instructions.
  • Added a dynamic PyPI version badge to README.md to highlight pip-installable support.

📚 Documentation preview 📚: https://UrbanMapper--57.org.readthedocs.build/en/57/

…lity

- Revised installation steps in README.md, CONTRIBUTING.md, and the installation guide to reflect UrbanMappers availability on PyPI, including clearer environment setup instructions.
- Added a dynamic PyPI version badge to README.md to highlight pip-installable support.
@soniacq soniacq requested a review from simonprovost May 21, 2025 15:29
@simonprovost simonprovost added the documentation Improvements or additions to documentation label May 21, 2025
@simonprovost simonprovost linked an issue May 21, 2025 that may be closed by this pull request
5 tasks
Copy link
Member

@simonprovost simonprovost left a comment

Choose a reason for hiding this comment

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

Hey @soniacq ! Thanks so much for this contribution 🎉 Brills for the contributing page, we good on that, regarding the README and the Getting started materials, we may need a little bit of changes but nothing of a big-deal!

Let me know when this is ready 💪

Important

To avoid any issue, here I would suggest you simply amend your changes to your current available commit, no need for more, one is indeed sufficient enough.

Cheers

@soniacq soniacq requested a review from simonprovost May 21, 2025 20:21
Copy link
Member

@simonprovost simonprovost left a comment

Choose a reason for hiding this comment

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

Amazing! Let's merge that PR 🎉

Quick tips for next time: for cleanliness, you could have amended your changes to your sole commit as it was "targeted" to be in that commit initially anyway, see more in: https://www.atlassian.com/git/tutorials/rewriting-history

Yet no big deal let's merge that necessary improvement, thanks @soniacq 🙏

@simonprovost simonprovost merged commit b94f23e into main May 21, 2025
8 checks passed
@soniacq soniacq deleted the doc_pip_install branch June 23, 2025 18:28
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.

Make UrbanMapper Pip-Installable for Easier Installation and Version Management

2 participants