Add pip requirements.txt and Pipfile #8
Conversation
Add a requirements.txt for installation via pip, as well as Pipfile/.lock usable by Pipenv and eventual pip Pipfile support.
TimEvens
left a comment
TimEvens
left a comment
There was a problem hiding this comment.
Thanks for submitting this. I have a few comments.
Pipfile.lock
Outdated
| @@ -0,0 +1,29 @@ | |||
| { | |||
There was a problem hiding this comment.
I was checking https://github.com/pypa/pipfile and it appears that you do not need to supply this file as it should be generated. If it's generated, then this shouldn't be included in the repo. Is there another reason why the lock file is included?
There was a problem hiding this comment.
The Pipfile.lock enables deterministic builds - just meaning that the exact same code will be utilized. We can remove this.
There was a problem hiding this comment.
There was a problem hiding this comment.
Per this - we should probably leave it here unless you don't care about library versioning.
Pipfile
Outdated
| verify_ssl = true | ||
|
|
||
| [packages] | ||
| python-snappy = "*" |
There was a problem hiding this comment.
Can you add minimum version requirements?
- python-snappy >= 0.5
- kafka-python >= 1.3.0
- PyYAML >= 3.11
There was a problem hiding this comment.
Should this apply to requirements.txt as well with minimum versions instead of exact (==)?
Pipfile
Outdated
| @@ -0,0 +1,8 @@ | |||
| [[source]] | |||
| url = "https://pypi.python.org/simple" | |||
There was a problem hiding this comment.
source should be: https://github.com/OpenBMP/openbmp-python-api-message
There was a problem hiding this comment.
I'm like 80% sure that the source should be the source for the project requirements - not the source of the project itself. I can't find any examples of Pipfiles that don't use pypi as a source - it might be too early in its development. https://github.com/pypa/pipfile#pipfile-1
I looked through the code for pipfile and Pipenv, and I can't tell for certain. Need to find a complete spec, which I'm not certain exists right now.
Pipenv automatically converts requirements.txt to Pipfile format.
|
@TimEvens I have removed the Pipenv related materials and added the minimum versioning requirements to requirements.txt. Installation of dependencies is now just |
2 participants
Add a pip requirements.txt and Pipfile/.lock to be used for installation of the library dependencies.
This resolves the need to manually install requirements detailed in README.md and can be updated with specific versioning as required. Or updated to automatically use the latest version, just request the change in the current code.