mpremote: Implement mip install from GitLab. #13791

OlivierLenoir · 2024-03-01T12:32:43Z

mpremote: Implement mip install from GitLab.

tools/mpremote/README.md: Add mip install gitlab:org/repo@branch.
Add example mpremote mip install gitlab:org/repo@branch.

tools/mpremote/mpremote/mip.py: Implement install from GitLab.
Modify _rewrite_url() to allow mip install from gitlab: repository.

mpremote/mpremote/main.py: Add gitlab:org/repo, gitlab:org/repo@branch.
Modify argparse_mip() for gitlab:org/repo, gitlab:org/repo@branch.

docs/reference/packages.rst: Mip install from GitLab.
Describe how to mip install from GitLab.

docs/reference/mpremote.rst: Install package from GitLab.
Install the package from the specified branch at org/repo on GitLab.

Signed-off-by: Olivier Lenoir olivier.len02@gmail.com

codecov · 2024-03-01T12:35:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.39%. Comparing base (025d10a) to head (e816b49).

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #13791   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files         161      161           
  Lines       21204    21204           
=======================================
  Hits        20864    20864           
  Misses        340      340

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-03-01T12:40:11Z

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS

OlivierLenoir · 2024-03-01T20:38:30Z

Both pull requests are link to the same implementation of mip install from GitLab.

Signed-off-by: Olivier Lenoir olivier.len02@gmail.com

micropython/micropython-lib#816

Modify _rewrite_url() to allow mip install from gitlab: repository.

Signed-off-by: Olivier Lenoir olivier.len02@gmail.com

#13791

mpremote: Implement mip install from GitLab.

tools/mpremote/README.md: Add mip install gitlab:org/repo@branch.
Add example mpremote mip install gitlab:org/repo@branch.

tools/mpremote/mpremote/mip.py: Implement install from GitLab.
Modify _rewrite_url() to allow mip install from gitlab: repository.

mpremote/mpremote/main.py: Add gitlab:org/repo, gitlab:org/repo@branch.
Modify argparse_mip() for gitlab:org/repo, gitlab:org/repo@branch.

docs/reference/packages.rst: Mip install from GitLab.
Describe how to mip install from GitLab.

docs/reference/mpremote.rst: Install package from GitLab.
Install the package from the specified branch at org/repo on GitLab.

Signed-off-by: Olivier Lenoir olivier.len02@gmail.com

jimmo

Looks good, thanks @OlivierLenoir !

jimmo · 2024-03-07T01:14:04Z

docs/reference/packages.rst

@@ -56,6 +56,24 @@ If no json file is specified, then "package.json" is implicitly added::
    >>> mip.install("github:org/repo")  # Uses default branch of that repo
    >>> mip.install("github:org/repo", version="branch-or-tag")

+The URL can also start with ``gitlab:`` as a simple way of pointing to content


Thanks for adding docs.

This section mostly just duplicates the above though, and because the gitlab support works in exactly the same way at github, maybe just say

The URL can also start with ``gitlab:`` and works in exactly the same way as GitHub URLs described above ``gitlab:org/repo[/path]``, including support for branches.

OlivierLenoir · 2024-03-08T16:07:45Z

@jimmo , I've aggregated both topics into one. I've also added a deps example with gitlab:.
Let me know if you valid the documentations modification.

jimmo

Thanks for updating! Please squash the commits down to a single commit (or if you want, one to the code and one to the docs).

jimmo · 2024-03-12T00:52:29Z

docs/reference/packages.rst

-The URL can also start with ``github:`` as a simple way of pointing to content
-hosted on GitHub::
+The URL can also start with ``github:`` or ``gitlab:`` as a simple way of pointing to content
+hosted on GitHub:: or GitLab::


Extra :: after GitHub

OlivierLenoir · 2024-03-12T14:51:26Z

Thanks for updating! Please squash the commits down to a single commit (or if you want, one to the code and one to the docs).

OlivierLenoir · 2024-03-12T15:04:37Z

@jimmo, I've fix the extra :: after github.
Regarding your demand to squash down to a single commit, I'm not certain how to do, it's my first real contribution to MicroPython project.
I plan to rebase my local git repository, but is it the right method?

git rebase -i HEAD~<number_of_commit>
git push --force-with-lease

As 5 files have been updated, what should be the commit first line and comment?
Can you help?

robert-hh · 2024-03-13T21:09:31Z

You PR seems completely messed up, since it contains all the STATIC->static changes.
Did you rebase your branch before changing the STATIC case locally? Then

OlivierLenoir · 2024-03-13T21:23:15Z

You PR seems completely messed up, since it contains all the STATIC->static changes. Did you rebase your branch before changing the STATIC case locally? Then

I'm trying to rebase my commit into one, but it fail because I did not format the commit message as it should.
It seem that I'm not doing it the right way.
@robert-hh, what should I do? Drop my fork and start again? Thanks for your help.

jimmo · 2024-03-14T03:40:40Z

@OlivierLenoir This might help: https://github.com/jimmo/git-and-micropython

Basically if you do a rebase -i and remove all the lines for commits that aren't relevant to your PR.

OlivierLenoir · 2024-03-14T06:43:09Z

@jimmo I think it's now correct, thanks to your help: https://github.com/jimmo/git-and-micropython.
What is the next step, if any?

stinos · 2024-03-14T10:01:16Z

docs/reference/packages.rst


 More sophisticated packages (i.e. with more than one file, or with dependencies)
 can be downloaded by specifying the path to their ``package.json``.

    >>> mip.install("http://example.com/x/package.json")
    >>> mip.install("github:org/user/path/package.json")
+    >>> mip.install("gitlab:org/user/path/package.json")


Just wondering but do we really want to repeat this in every single example in all involved readme/.rst files? Because suppose we add another method then we'd also have to adjust all locations again?

I just consider that example should be explicit to ease search and understanding.
I've done it searching for github:, and now gitlab:.

$ grep -rl "github:\|gitlab:" tools/mpremote/README.md tools/mpremote/mpremote/mip.py tools/mpremote/mpremote/main.py docs/reference/packages.rst docs/reference/mpremote.rst

Changes are: - main.py: Add gitlab:org/repo, gitlab:org/repo@branch. - mip.py: Implement install from GitLab. - README.md: Add mip install gitlab:org/repo@branch example. Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>

Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>

dpgeorge · 2024-05-15T03:59:35Z

Thanks for the contribution! Now merged.

OlivierLenoir mentioned this pull request Mar 1, 2024

micropython/mip/mip/__init__.py: Implement install from gitlab. micropython/micropython-lib#816

Closed

jimmo reviewed Mar 7, 2024

View reviewed changes

jimmo reviewed Mar 12, 2024

View reviewed changes

OlivierLenoir force-pushed the dev-branch branch 2 times, most recently from 8b232e9 to 370e6a1 Compare March 13, 2024 21:02

OlivierLenoir force-pushed the dev-branch branch from 370e6a1 to e32d0ff Compare March 13, 2024 21:13

OlivierLenoir force-pushed the dev-branch branch from e32d0ff to 4d70f62 Compare March 14, 2024 06:20

stinos reviewed Mar 14, 2024

View reviewed changes

dpgeorge added the tools label Mar 15, 2024

mattytrentini added the maintainer-queue label Mar 17, 2024

dpgeorge added this to the release-1.23.0 milestone May 14, 2024

OlivierLenoir added 2 commits May 15, 2024 13:32

tools/mpremote: Add support to mip install from GitLab.

85c85e8

Changes are: - main.py: Add gitlab:org/repo, gitlab:org/repo@branch. - mip.py: Implement install from GitLab. - README.md: Add mip install gitlab:org/repo@branch example. Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>

docs/reference: Document how to mip install packages from GitLab.

e816b49

Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>

dpgeorge force-pushed the dev-branch branch from 4d70f62 to e816b49 Compare May 15, 2024 03:36

dpgeorge merged commit e816b49 into micropython:master May 15, 2024
64 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mpremote: Implement mip install from GitLab. #13791

mpremote: Implement mip install from GitLab. #13791

OlivierLenoir commented Mar 1, 2024

codecov bot commented Mar 1, 2024 •

edited

github-actions bot commented Mar 1, 2024

OlivierLenoir commented Mar 1, 2024 •

edited

jimmo left a comment

jimmo Mar 7, 2024

OlivierLenoir commented Mar 8, 2024

jimmo left a comment

jimmo Mar 12, 2024

OlivierLenoir commented Mar 12, 2024

OlivierLenoir commented Mar 12, 2024

robert-hh commented Mar 13, 2024

OlivierLenoir commented Mar 13, 2024

jimmo commented Mar 14, 2024

OlivierLenoir commented Mar 14, 2024

stinos Mar 14, 2024

OlivierLenoir Mar 14, 2024

dpgeorge commented May 15, 2024

mpremote: Implement mip install from GitLab. #13791

mpremote: Implement mip install from GitLab. #13791

Conversation

OlivierLenoir commented Mar 1, 2024

codecov bot commented Mar 1, 2024 • edited

Codecov Report

github-actions bot commented Mar 1, 2024

OlivierLenoir commented Mar 1, 2024 • edited

jimmo left a comment

Choose a reason for hiding this comment

jimmo Mar 7, 2024

Choose a reason for hiding this comment

OlivierLenoir commented Mar 8, 2024

jimmo left a comment

Choose a reason for hiding this comment

jimmo Mar 12, 2024

Choose a reason for hiding this comment

OlivierLenoir commented Mar 12, 2024

OlivierLenoir commented Mar 12, 2024

robert-hh commented Mar 13, 2024

OlivierLenoir commented Mar 13, 2024

jimmo commented Mar 14, 2024

OlivierLenoir commented Mar 14, 2024

stinos Mar 14, 2024

Choose a reason for hiding this comment

OlivierLenoir Mar 14, 2024

Choose a reason for hiding this comment

dpgeorge commented May 15, 2024

codecov bot commented Mar 1, 2024 •

edited

OlivierLenoir commented Mar 1, 2024 •

edited