feat(docs): add python and poetry plugin docs #1940
+142
−0
Conversation
This file contains 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
lengau
force-pushed
the
work/1913/CRAFT-3425/python-poetry
branch
from
b0ebaa0
to
df6780b
Compare
medubelko
requested changes
Oct 11, 2024
| 2. It uses :command:`poetry export` to create a ``requirements.txt`` in the project's | ||
| build directory. | ||
| 3. It uses :command:`pip` to install the packages referenced in ``requirements.txt`` | ||
| into the virtual environment, without any additional dependencies. |
There was a problem hiding this comment.
additional dependencies.
I don't fully understand what "additional" suggests here. Can you elaborate?
Comment on lines
+35
to
+36
| 4. It copies the ``src`` and ``lib`` directories from your charm project into the | ||
| final charm if they exist. |
There was a problem hiding this comment.
This might flow better, and avoid implying src && lib, as:
4. It copies any existing ``src`` and ``lib`` directories from your charm project into the
final charm.
Comment on lines
+1
to
+5
| name: my-charm | ||
| type: charm | ||
| title: My operator charm | ||
| summary: A charm that uses the operator framework | ||
| description: A charm that uses the operator framework |
There was a problem hiding this comment.
I think it would be better if the metadata were germane to the Poetry plugin.
Comment on lines
+1
to
+5
| name: my-charm | ||
| type: charm | ||
| title: My operator charm | ||
| summary: A charm that uses the operator framework | ||
| description: A charm that uses the operator framework |
There was a problem hiding this comment.
Same here. How about we orient these around Python?
Comment on lines
+6
to
+7
| The Python plugin can be used for charms written in Python, typically for charms | ||
| using the `Operator framework`_. |
There was a problem hiding this comment.
Suggested change
| The Python plugin can be used for charms written in Python, typically for charms | |
| using the `Operator framework`_. | |
| The Python plugin builds charms written in Python. It's typically | |
| used in conjunction with the `Operator framework`_. |
Comment on lines
+27
to
+29
| This plugin creates a Python virtual environment in the ``venv`` directory of your | ||
| charm using the version of Python included with your base, using the requirements files | ||
| provided in the ``python-requirements`` keyword. |
There was a problem hiding this comment.
Suggested change
| This plugin creates a Python virtual environment in the ``venv`` directory of your | |
| charm using the version of Python included with your base, using the requirements files | |
| provided in the ``python-requirements`` keyword. | |
| This plugin creates a Python virtual environment in the ``venv`` directory of your | |
| charm using the version of Python included with your base and the requirements files | |
| provided in the ``python-requirements`` key. |
| directory. | ||
| 2. It uses :command:`pip` to install the required Python packages as configured | ||
| in the ``python-requirements``, ``python-constraints`` and ``python-packages`` | ||
| keywords. |
Comment on lines
+46
to
+47
| 2. It uses :command:`pip` to install the required Python packages as configured | ||
| in the ``python-requirements``, ``python-constraints`` and ``python-packages`` |
There was a problem hiding this comment.
Suggested change
| 2. It uses :command:`pip` to install the required Python packages as configured | |
| in the ``python-requirements``, ``python-constraints`` and ``python-packages`` | |
| 2. It uses :command:`pip` to install the required Python packages specified | |
| by the ``python-requirements``, ``python-constraints`` and ``python-packages`` |
Food for thought. I think it's best if we don't overload "configure".
Comment on lines
+49
to
+50
| 3. It copies the ``src`` and ``lib`` directories from your charm project into the | ||
| final charm if they exist. |
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.
This adds documentation for the Python and Poetry plugins.
It builds upon #1939 and requires canonical/craft-parts#872
NOTE: This still needs a craft-parts update for all docs rendering to work properly, but please review what you can ITMT