PipEnv docs added #4247
Merged
PipEnv docs added #4247
+186
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This won't pass until we merge the PR |
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
| ---------------------------------- | ||
|
|
||
| To use a tool installed with Python, we have to install it using the ``PipEnv install`` method. | ||
| We also have to call the ``PipEnv generate`` method to create a ``Conan Environment`` to adds the ``Python virtualenv path`` to the system path. |
There was a problem hiding this comment.
Please, use backticks mostly for things related to source code.
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
reference/tools/system.rst
Outdated
| :maxdepth: 2 | ||
|
|
||
| system/package_manager | ||
| system/pip_manager |
There was a problem hiding this comment.
I think this file should not be named pip_manager but pipenv or something similar.
czoido
reviewed
Sep 29, 2025
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
memsharded
reviewed
Sep 29, 2025
reference/tools/system/pipenv.rst
Outdated
Comment on lines
7
to
18
| The ``PipEnv`` helper installs Python packages with **pip** inside a dedicated virtual environment (**venv**), | ||
| keeping them isolated so they don't interfere with system packages or the Conan package itself. | ||
|
|
||
| .. currentmodule:: conan.tools.system | ||
|
|
||
| .. autoclass:: PipEnv | ||
| :members: | ||
| :inherited-members: | ||
|
|
||
| It is designed to be used in two different ways: | ||
|
|
||
| 1. Using a Python package in a recipe. |
There was a problem hiding this comment.
All this, probably the whole doc need to emphasize this is only for executable Python packages. This approach doesn't work for library-like Python code that you expect to use via import
There was a problem hiding this comment.
Probably an important note at the beginning to clarify this would help.
AbrilRBS
reviewed
Sep 29, 2025
reference/tools/system/pipenv.rst
Outdated
|
|
||
| These two steps appear in the following recipe in the ``generate()`` method. | ||
| Calling it in this method ensures that the **Python package** and the **Conan Environment** will be available in the following steps. | ||
| In this case, in the build step, which is where we will use it. |
There was a problem hiding this comment.
I don't quite know what this sentence is referring to
There was a problem hiding this comment.
What this means is that if you haven't called it in the generate method, it won't be available in the build method, because the conan environment has to be generated before calling build.
Co-authored-by: Abril Rincón Blanco <5364255+AbrilRBS@users.noreply.github.com>
AbrilRBS
reviewed
Sep 29, 2025
Co-authored-by: Abril Rincón Blanco <5364255+AbrilRBS@users.noreply.github.com>
czoido
reviewed
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
czoido
reviewed
Sep 29, 2025
czoido
approved these changes
Sep 29, 2025
czoido
reviewed
Sep 29, 2025
memsharded
approved these changes
Sep 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for conan-io/conan#18923