Skip to content
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.

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

Add a document describing how p4a interacts with pip & python packages #1931

Merged
1 commit merged into from Jul 27, 2019
Merged

Add a document describing how p4a interacts with pip & python packages #1931

1 commit merged into from Jul 27, 2019

Conversation

ghost
Copy link

@ghost ghost commented Jul 25, 2019

This pull request adds an internal documentation (not build as part of user docs, I just put it in there so we can find it again - it's mainly meant to just sit around in a place where we can find it) describing how p4a interacts with pip & python packages. This is mainly meant for pip developers and others outside of our team to be able to get an idea what we're doing, although of course it could also be interesting to newcomers to our own team!

Please have fun reading and tell me if anything doesn't make sense!

inclement
inclement previously approved these changes Jul 26, 2019
Copy link
Member

@inclement inclement left a comment

Choose a reason for hiding this comment

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

Looks quite complete to me, nice.

Although I would add full stops in a lot of places :<

doc/internal-dev-info/how-pi4a-uses-pip.md Outdated Show resolved Hide resolved
@inclement
Copy link
Member

Oh, and as for where this goes, I don't think it would be inappropriate to put it in the documentation. It could be e.g. a subpage of "Development and Contributing". I don't think that would cause issues, and it would be nice to have it be discoverable and easily referenceable in the compiled documentation.

@ghost
Copy link
Author

ghost commented Jul 26, 2019

@inclement good point! I added it into the "Development and Contributing" section now. will also make it easier to link once it's out on read the docs

AndreMiras
AndreMiras previously approved these changes Jul 27, 2019
Copy link
Member

@AndreMiras AndreMiras left a comment

Choose a reason for hiding this comment

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

This documentation is a good addition, thanks.
I only saw a minor typo and also the missing full stops also bugged me 😄
In general what p4a is doing with the recipes reminds me what Gentoo (source distribution) is doing with Ebuilds. Ebuild basically has the same features, dependencies management, patching, build tools...

Copy link
Member

@AndreMiras AndreMiras left a comment

Choose a reason for hiding this comment

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

LGTM

@ghost ghost merged commit 8cf23aa into kivy:develop Jul 27, 2019
@ghost ghost deleted the packaging-dev-doc branch July 28, 2019 15:06
This pull request was closed.
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.

2 participants