Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: list pyprojectx as alternative to install PDM #1004

Closed
houbie opened this issue Mar 29, 2022 · 2 comments
Closed

documentation: list pyprojectx as alternative to install PDM #1004

houbie opened this issue Mar 29, 2022 · 2 comments
Labels
📖 documentation Improvements or additions to documentation ❓ help wanted Extra attention is needed

Comments

@houbie
Copy link
Contributor

houbie commented Mar 29, 2022

Pyprojectx provides a wrapper script that bootstraps the installation of all the development tools used in a project. As such it has the ability to install PDM on demand.

The benefits:

  • you can clone and build a project without having to install PDM first
  • you can lock the PDM version: this makes your project immune for breaking changes in PDM; as developer you don't need to install/select the required version
  • projects become beginner-friendly as nothing needs to be set up

Pyprojectx has a PDM initializer: it installs PDM locally inside the project and starts pdm init

The px-demo project shows how you can build a PDM project in a minute:

git clone https://github.com/pyprojectx/px-demo.git
cd px-demo
./pw build

IMO it makes sense to add this to the documentation.

@houbie houbie added the ⭐ enhancement Improvements for existing features label Mar 29, 2022
@frostming
Copy link
Collaborator

Sure, it is a nice tool! Would you like to make the PR?

@frostming frostming added ❓ help wanted Extra attention is needed 📖 documentation Improvements or additions to documentation and removed ⭐ enhancement Improvements for existing features labels Mar 30, 2022
@houbie
Copy link
Contributor Author

houbie commented Mar 30, 2022

Will do that

houbie pushed a commit to houbie/pdm that referenced this issue Mar 30, 2022
houbie pushed a commit to houbie/pdm that referenced this issue Mar 31, 2022
houbie pushed a commit to houbie/pdm that referenced this issue Apr 4, 2022
houbie pushed a commit to houbie/pdm that referenced this issue Apr 4, 2022
frostming pushed a commit that referenced this issue Apr 5, 2022
* #1004 add 'inside project' pyprojectx installation tab

* #1004 add news item

Co-authored-by: ihoubr <[email protected]>
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 ❓ help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants