New ADR: Use Poetry for Python packaging and dependency management #10
Conversation
esciara
changed the title
esciara
force-pushed
the
adr-poetry
branch
3 times, most recently
from
676e743 to
9d8d7d9
Compare
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| Standard `setuptool` forces up to use 5 different files to create a package, making it |
There was a problem hiding this comment.
5 files ? Seems a lot, could they be listed here ?
| Standard `setuptool` forces up to use 5 different files to create a package, making it | ||
| quite complicated to create packages. we want to find an alternative. | ||
|
|
||
| ## Considered Options |
There was a problem hiding this comment.
Official Python guidelines : https://packaging.python.org/guides/tool-recommendations recommend also to use pip. It could be listed in considered options.
| Chosen option: "Poetry", because of all the arguments detailed in one of the articles | ||
| that helped us decide: [A deeper look into Pipenv and Poetry](https://frostming.com/2019/01-04/pipenv-poetry) | ||
|
|
||
| ### Positive Consequences <!-- optional --> |
There was a problem hiding this comment.
If none is observed, delete this section
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] | ||
| * ... | ||
|
|
||
| ### Negative Consequences <!-- optional --> |
There was a problem hiding this comment.
If none is observed, delete this section.
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] | ||
| * ... | ||
|
|
||
| ### Negative Consequences <!-- optional --> |
There was a problem hiding this comment.
Difficulties to manage/maintain the poetry lock could be observed as one negative consequence.
| * [e.g., improvement of quality attribute satisfaction, follow-up decisions required, ...] | ||
| * ... | ||
|
|
||
| ### Negative Consequences <!-- optional --> |
There was a problem hiding this comment.
Users have to learn how to use this tool which is not the python standard.
Users have to install a new tool on their local environment to develop.
| * [e.g., compromising quality attribute, follow-up decisions required, ...] | ||
| * ... | ||
|
|
||
| ## Pros and Cons of the Options <!-- optional --> |
There was a problem hiding this comment.
Pros and cons are missing here.
I think we should compile them, it may be one of the most important part of this ADR, especially for the choice of this build tool
| ## Links | ||
|
|
||
| * [Tutorial] [Package Python Projects the Proper Way with Poetry](https://hackersandslackers.com/python-poetry-package-manager/) | ||
| * [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) --> |
There was a problem hiding this comment.
Remove unconfigured links
No description provided.