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

dist to pypi as pavics-magpie #518

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

dist to pypi as pavics-magpie #518

wants to merge 3 commits into from

Conversation

fmigneault
Copy link
Collaborator

@fmigneault fmigneault commented May 20, 2022

Blocking Issues

PyPI requires that all dist_require packages are publicly accessible using pip install <pkg>.
Because of this, URL commit/branch references are not permitted.

The package distribution is blocked by the following PR (so new official versions are published) until Mapgie can be pushed as well:

Breaking Change

Big downside, INI is not backward compatible.
Because magpie is already taken on PyPI, and that the INI paste deploy loads using the same distribution name, all existing INI file references will have to change their reference to pavics-magpie.

ToDo

If we move on with this change, following must be done:

  • update requirements by URL references with pinned versions directly referring to pypi packages.
  • update all stack/instances that use an override Magpie INI config
  • add important changelog warning
  • major version update
  • add PYPI_API_TOKEN secret to repo to allow upload of tagged version by CI

@fmigneault fmigneault self-assigned this May 20, 2022
@github-actions github-actions bot added ci Something related to code tests, deployment and packaging tests Test execution or additional use cases labels May 20, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #518 (cf27f19) into master (27e060a) will increase coverage by 0.00%.
The diff coverage is 70.00%.

❗ Current head cf27f19 differs from pull request most recent head c7c23eb. Consider uploading reports for the commit c7c23eb to get more accurate results

@@           Coverage Diff           @@
##           master     #518   +/-   ##
=======================================
  Coverage   80.27%   80.27%           
=======================================
  Files          71       71           
  Lines        9615     9616    +1     
  Branches     1323     1323           
=======================================
+ Hits         7718     7719    +1     
  Misses       1597     1597           
  Partials      300      300           
Impacted Files Coverage Δ
magpie/api/login/__init__.py 100.00% <ø> (ø)
magpie/register.py 48.26% <18.18%> (+<0.01%) ⬆️
magpie/models.py 89.13% <60.00%> (ø)
magpie/api/login/login.py 57.67% <66.66%> (ø)
magpie/ui/utils.py 67.39% <66.66%> (ø)
magpie/services.py 79.52% <71.42%> (ø)
magpie/adapter/magpieservice.py 58.10% <83.33%> (ø)
magpie/__meta__.py 100.00% <100.00%> (ø)
magpie/api/exception.py 93.52% <100.00%> (ø)
magpie/api/management/user/user_utils.py 97.11% <100.00%> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d2857cb...c7c23eb. Read the comment docs.

@fmigneault fmigneault requested a review from dbyrns May 20, 2022 18:51
@fmigneault
Copy link
Collaborator Author

@dbyrns Because there was a discussion about that recently, I gave a try to publish Magpie to PyPI. I found the issues listed in the PR description. Some of them make me feel it is not worth doing the change because it introduces a breaking change on existing platforms (mounted INI file in dockers).

@dbyrns
Copy link
Contributor

dbyrns commented May 20, 2022

If there is no hard requirement for a pypi package, keeping this as a nice to have is ok.

@fmigneault fmigneault added the enhancement Improvements in term of performance or behaviour label May 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Something related to code tests, deployment and packaging enhancement Improvements in term of performance or behaviour tests Test execution or additional use cases
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants