Dev pydev guide #149
Merged
Dev pydev guide #149
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
peppelinux
reviewed
Aug 6, 2024
README-Python-Dev.md
Outdated
|
|
||
| ## Step 0: Identify which Python dependency requires development | ||
|
|
||
| We will assume that the developer want to develop a modified version of the library [eudi-wallet-it-python](https://github.com/italia/eudi-wallet-it-python) which is a dependency of the container `satosa-saml2spid`. |
There was a problem hiding this comment.
Suggested change
| We will assume that the developer want to develop a modified version of the library [eudi-wallet-it-python](https://github.com/italia/eudi-wallet-it-python) which is a dependency of the container `satosa-saml2spid`. | |
| We assume that the developer needs to develop a modified version of the library [eudi-wallet-it-python](https://github.com/italia/eudi-wallet-it-python) which is a dependency of the container `satosa-saml2spid`. |
peppelinux
reviewed
Aug 6, 2024
README-Python-Dev.md
Outdated
|
|
||
| We will assume that the developer want to develop a modified version of the library [eudi-wallet-it-python](https://github.com/italia/eudi-wallet-it-python) which is a dependency of the container `satosa-saml2spid`. | ||
| A local copy of the library is required. | ||
| We will assume that the project eudi-wallet-it-python has been cloned in the folder `/home/username/my/development/folder/eudi-wallet-it-python/pyeudiw`. The path prefix `/home/username/my/development/folder/` is an example and should be replaced here with the location of your own development package. |
There was a problem hiding this comment.
Suggested change
| We will assume that the project eudi-wallet-it-python has been cloned in the folder `/home/username/my/development/folder/eudi-wallet-it-python/pyeudiw`. The path prefix `/home/username/my/development/folder/` is an example and should be replaced here with the location of your own development package. | |
| We assume that the project eudi-wallet-it-python has been cloned in the folder `/home/username/my/development/folder/eudi-wallet-it-python/pyeudiw`. The path prefix `/home/username/my/development/folder/` is an example and should be replaced here with the location of your own development package. |
There was a problem hiding this comment.
applied in af64492
peppelinux
reviewed
Aug 6, 2024
README-Python-Dev.md
Outdated
|
|
||
| ## Step 4 (Optional): Install further dependencies in the container | ||
|
|
||
| If your version of the library containes further dependency, or if you want to install development only dependency such as, say [pdbpp](https://github.com/pdbpp/pdbpp), you can create a new image that contains the required dependency. |
There was a problem hiding this comment.
Suggested change
| If your version of the library containes further dependency, or if you want to install development only dependency such as, say [pdbpp](https://github.com/pdbpp/pdbpp), you can create a new image that contains the required dependency. | |
| If your version of the library contains further dependencies, or if you want to install development only dependencies such as, say [pdbpp](https://github.com/pdbpp/pdbpp), you can create a new image that contains the required dependency or execute a terminal (such as a `bash`) within the container and install it manually, therefore commit the changes to the docker container, as shown in the next section. |
There was a problem hiding this comment.
Note that docker container commit command actually creates a new image (see the docs) hence the proposed addition is technically redundant.
Since this might not be a well known detail of the command, I am happy to include the proposed addition.
peppelinux
reviewed
Aug 6, 2024
README-Python-Dev.md
Outdated
| 4. Freeze the changes with the command `docker container commit satosa-saml2spid`. | ||
| 5. Stop and then restart the container. | ||
|
|
||
| At the end of the procedure, you will have created a new updated image with the required dependency. |
There was a problem hiding this comment.
Suggested change
| At the end of the procedure, you will have created a new updated image with the required dependency. | |
| At the end of the procedure, you will find the required dependency as part of your container. |
peppelinux
approved these changes
Aug 6, 2024
|
I suggest to link this pydev documentation in the main README, within the section dedicated to the developers |
Done in b181b6e |
peppelinux
approved these changes
Aug 7, 2024
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.
Pull request #143 added ease of support for developing within a docker environment, but did not further explain how to do so and assumed that the reader has the technical capabilities and experties to perform this operation.
This assumption, in general, might not be true and this pull request aims at providing documentation on how to fill this gap.
Suggestion on how to improve this block of documentation is well accepted.