How to mip install from gitlab repository?

[OlivierLenoir]

How to mip install from gitlab.com repository?

I've created a test repository on gitlab.com.

• Is my package.json file correct?
• Can we mpremote mip install from gitlab and how?

[jimmo]

This should work -- mip supports installing from any HTTP(s) source.

However, mip has a special convenience shortcut for GitHub that allows you to write github:org/repo to access the files.

If you want to use gitlab.com:olivierlenoir/... like in your example package.json you would need to add support for GitLab URLs to mip. See https://github.com/micropython/micropython-lib/blob/master/micropython/mip/mip/__init__.py#L64 for where the GitHub support is implemented.

[OlivierLenoir]

I don't know how to test an implementation of gitlab:, but here is how we could implement it (to be tested):
https://github.com/micropython/micropython-lib/blob/master/micropython/mip/mip/init.py#L64

def _rewrite_url(url, branch=None):
    if not branch:
        branch = "HEAD"
    if url.startswith("github:"):
        url = url[7:].split("/")
        url = (
            "https://raw.githubusercontent.com/"
            + url[0]
            + "/"
            + url[1]
            + "/"
            + branch
            + "/"
            + "/".join(url[2:])
        )
    if url.startswith("gitlab:"):
        url = url[7:].split("/")
        url = (
            "https://gitlab.com/"
            + url[0]
            + "/"
            + url[1]
            + "/-/raw/"
            + branch
            + "/"
            + "/".join(url[2:])
        )
    return url

#...


def _install_package(package, index, target, version, mpy):
    if (
        package.startswith("http://")
        or package.startswith("https://")
        or package.startswith("github:")
        or package.startswith("gitlab:")
    ):
#...

Could you check if it can be implement and documented?

[OlivierLenoir]

@jimmo, I've been able to test my above proposition to implement gitlab: by modifying my local mip.py.
It works.

$ mpremote mip install gitlab:olivierlenoir/MipTest
Install gitlab:olivierlenoir/MipTest
Installing gitlab:olivierlenoir/MipTest/package.json to /lib
Installing: /lib/logger.py
Installing: /lib/softapwebserver.py         
Done                                        

My gitlab.com repository https://gitlab.com/olivierlenoir/MipTest

[OlivierLenoir]

@jimmo, I've pull request to implement gitlab:.

[OlivierLenoir]

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

• micropython/mip/mip/__init__.py: Implement install from gitlab. micropython-lib#816
• mpremote: Implement mip install from GitLab. #13791

Signed-off-by: Olivier Lenoir [email protected]

---

micropython/micropython-lib#816

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

Signed-off-by: Olivier Lenoir [email protected]

---

#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 [email protected]

[OlivierLenoir]

I didn't find the equivalent of https://raw.githubusercontent.com/ for gitlab, but here is what I did.

$ mpremote mip install https://gitlab.com/olivierlenoir/MipTest/-/raw/main
Install https://gitlab.com/olivierlenoir/MipTest/-/raw/main
Installing https://gitlab.com/olivierlenoir/MipTest/-/raw/main/package.json to /lib
Installing: /lib/logger.py
Installing: /lib/softapwebserver.py         
Done                                        

package.json

{
    "urls": [
        ["logger.py", "https://gitlab.com/olivierlenoir/MipTest/-/raw/main/micropython/logger.py"],
        ["softapwebserver.py", "https://gitlab.com/olivierlenoir/MipTest/-/raw/main/micropython/softapwebserver.py"]
    ],
    "deps": [
    ],
    "version": "0.1.0"
}

It works.
Thanks,