Skip to content

docs: add Pixi setup instructions for macOS - #1931

Closed
kurupashwin482-web wants to merge 1 commit into
python:mainfrom
kurupashwin482-web:docs/add-pixi-macos
Closed

kurupashwin482-web wants to merge 1 commit into
python:mainfrom
kurupashwin482-web:docs/add-pixi-macos

Conversation

@kurupashwin482-web

Copy link
Copy Markdown

Summary

  • Add a Pixi tab to the macOS CPython build instructions.
  • Document the dependencies and environment variables in a pixi.toml manifest.
  • Explain how to install dependencies, configure CPython, and build it using Pixi.
  • Clarify that the shared make instruction applies to Homebrew and MacPorts.

Testing

  • sphinx-lint on getting-started/setup-building.rst: passed.
  • git diff --check: passed.
  • The full documentation check did not complete because of a No module named sphinxlint error.
  • The macOS build has not been tested locally.

Related issue: #1669

@python-cla-bot

Copy link
Copy Markdown

The following commit authors need to sign the Contributor License Agreement:

CLA not signed

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #35333220 | 📁 Comparing 3382c4b against latest (ff9af79)

  🔍 Preview build  

1 file changed
± getting-started/setup-building/index.html


For **Pixi**, install Pixi by following the
`installation instructions <https://pixi.sh/latest/installation/>`__.
Create a :file:`pixi.toml` file in the CPython source directory

@StanFromIreland StanFromIreland Oct 22, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What about the existing pixi files we bundle?

@kurupashwin482-web

Copy link
Copy Markdown
Author

Thanks for pointing this out! I hadn't accounted for the existing Pixi files bundled with CPython. I'll check how the proposed setup interacts with those files and update the instructions to avoid conflicting with the existing configuration.

@kurupashwin482-web

Copy link
Copy Markdown
Author

Thanks for raising this. I checked the CPython repository root and couldn't find a root-level pixi.toml. The existing Tools/pixi-packages/pixi.toml belongs to the Pixi package-build setup described in that directory's README, which appears to serve a different purpose from configuring a local CPython development environment.

I'll check whether the existing package definitions can be reused for this workflow before deciding how the documentation should create or reference a separate development manifest.

--with-pydebug

And finally, run ``make``::
.. tab:: Pixi

@willingc willingc Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the PR @kurupashwin482-web. I don't believe the devguide (or this section of the devguide) is the best place to provide build instructions using pixi. While I am a frequent user of Pixi and uv, I'm not sure it is necessary to support each tool here.

Thoughts from other core devs?

My recommendation would be to close this PR. @kurupashwin482-web, perhaps you would like to create your own blog post with this information instead or a Gist on GitHub.

@willingc

willingc commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

@lysnikolaou Since you created #1669, what are your thoughts? I could see including something about pixi and/or uv for setting up for working with free-threading.

Overall, I could see referring to the Tools section in CPython as a better approach in the devguide: https://github.com/python/cpython/blob/main/Tools/pixi-packages/README.md

@willingc

Copy link
Copy Markdown
Collaborator

Based on latest comments on #1669, there is consensus to document using pixi in a generic manner across the operating systems.

Let's continue discussing the best place to document this: an existing page or a new page.

I would like to make sure that we have @ngoldbaum as a reviewer on any pixi PR as well as Lucas.

@kurupashwin482-web

Copy link
Copy Markdown
Author

Thank you for the review and for the guidance. I understand that the Devguide may not be the best place for tool-specific Pixi instructions, and that the team is discussing a more general approach. I'll close this PR for now and look for a contribution that better fits the project's current direction. I appreciate everyone's time and feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants