8000 update readme for wppm package switch by stonebig · Pull Request #1673 · winpython/winpython · GitHub
[go: up one dir, main page]
Skip to content

update readme for wppm package switch #1673

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 6, 2025
Merged

update readme for wppm package switch #1673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Copyright @ 2012-2013 Pierre Raybaut
Copyright @ 2014-2025+ The Winpython development team https://github.com/winpython/

Licensed under the terms of the MIT License
(see winpython/__init__.py for details)
(see wppm/__init__.py for details)


Overview
Expand All @@ -15,17 +15,22 @@ Overview
WinPython is a portable distribution of the Python programming
language for Windows (https://winpython.github.io).

This is the `winpython` Python package, not the distribution itself.
This is the `wppm` Python package and build toolchain repository, not the distribution itself.
It includes two main features:

WinPython Package Manager (WPPM)
a complementary tool to navigate provided packages, install packages from included Wheelhouse, or register WinPython.
pip is the recommanded way to add or remove packages
pip is the recommanded way to add or remove packages otherwise

WinPython build toolchain
make.py is the script used to
generate_a_winpython_distro.bat and make.py are the toolchain used to
build a WinPython distribution from (almost) scratch.

WinPython set of Wheel
You can get also the equivalent of the WinPython distribution by using one of the provided pylock.toml
or by using provided requirements-with-hash.txt until pip does support pylock.toml files


Dependencies
------------

Expand All @@ -38,20 +43,27 @@ Requirements
* installer can be 7-Zip or nothing (just .zip-it)


Installation
------------
Wppm build
----------

From the source package (see section 'Building dependencies'), you may
install WinPython using the following commands:
build WPPM using the following commands:

**python -m pip install flit**

**python -m flit build**

**python -m pip install --no-index --trusted-host=None --find-links=.\dist winpython**
Winpython Distribution wheels installation
------------------------------------------

To only install the wheels assembled per WinPython Distribution, you may
**python -m pip install --no-deps --require-hashes https://github.com/winpython/winpython/releases/download/16.6.20250620final/requir.64-3_13_5_0slim.txt

A pylock file is also available, when you package manager can handle it
**https://github.com/winpython/winpython/releases/download/16.6.20250620final/pylock.64-3_13_5_0slim.toml

But the easiest way to install the last stable release of WinPython is
by using an executable installer: https://winpython.github.io/
by using a zipped distribution with or without auto-extractor: https://winpython.github.io/

More informations
-----------------
Expand All @@ -60,4 +72,4 @@ More informations

* Development, bug reports, discussions and feature requests: https://github.com/winpython/winpython

* Discussions: https://groups.google.com/group/winpython
* Discussions: https://github.com/winpython/winpython/discussions
0