linkedin / pygradle

Using Gradle to build Python projects
https://github.com/linkedin/pygradle
Apache License 2.0
586 stars 147 forks source link

Can we update the documentation to provide a full working example for 2020 onwards. #336

Open Ryan-Gordon1 opened 4 years ago

Ryan-Gordon1 commented 4 years ago

As it stands there are a bunch of gotchas with this project. From certain versions of packages not working (we eventually learn it is related to the fact they aren't pulling from Pypi) to having a very tight coupling to pivy-importer (which is admitted to be more of a throwaway as linkedin use an internal package) I feel the documentation needs an overall.

Without clear working examples to get this repo working in a project I feel its use is hindered. Theres alot of tacit knowledge involved. From what I can see in the github issues, the two example projects are heavily suggested to people. But neither of them seem to have been updated in two years.

Is there any official plan for maintaining this project?

Ryan-Gordon1 commented 4 years ago

To speak briefly on pivy-importer. It seems at an absolute minimum you need : virtualenv, pip, setuptools (in most cases) and whatever packages you need. I think there should be a list of needed modules to get started with this pypi+ivy approach

Ryan-Gordon1 commented 4 years ago

When trying to get packages with pivy importer it seems to be gathering the incorrect versions of packages. For example when getting flake and Sphinx it pulls in six:1.13 but 1.11 is required for the installBuildRequirements

Using details I can forceVersion of the package : forceVersion('pypi', 'six', '1.13.0') but I would rather it would accept a higher version of the package. Unless of course this version is pinned for a reason.