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.

Sign up for GitHub

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

Jump to bottom

[#202] propose VIP and NIPKG package formats #318

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[#202] propose VIP and NIPKG package formats #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions PURL-TYPES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,19 @@ mlflow
pkg:mlflow/creditfraud@3?repository_url=https://westus2.api.azureml.ms/mlflow/v1.0/subscriptions/a50f2011-fab8-4164-af23-c62881ef8c95/resourceGroups/TestResourceGroup/providers/Microsoft.MachineLearningServices/workspaces/TestWorkspace
pkg:mlflow/trafficsigns@10?model_uuid=36233173b22f4c89b451f1228d700d49&run_id=410a3121-2709-4f88-98dd-dba0ef056b0a&repository_url=https://adb-5245952564735461.0.azuredatabricks.net/api/2.0/mlflow

nipkg
-----
``nipkg`` for NI Package format packages:

- The ``namespace`` is the maintainer from the package attributes (optional).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does it mean for the maintainer to be optional? Is it optional because the maintainer has a default?

If it's optional because it doesn't matter, it shouldn't be included because that creates problems for code that needs to match PURLs.

- The ``name`` is the package name from from the package attributes.
- The ``version`` is the full version from the package attributes - not the display version.
- Examples::

pkg:nipkg/[email protected]
pkg:nipkg/ni-visa-17.5-dotnet-runtime
pkg:nipkg/National%20Instruments/[email protected]+f0

npm
---
``npm`` for Node NPM packages:
Expand Down Expand Up @@ -577,6 +589,20 @@ swift

pkg:swift/github.com/Alamofire/[email protected]
pkg:swift/github.com/RxSwiftCommunity/[email protected]

vip
---
``vip`` for VI Package Manager (VIPM) format packages (LabVIEW):

- The ``namespace`` is the company name from the package attributes (optional).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't seem like the namespace is used by the native vipm tools (the website makes links like vipm://oglib_numeric), so it probably should not be included here.

- The ``name`` is the package name from from the package attributes with the -version removed.
- The ``version`` is the version string from the package attributes.
- The qualifier ``repository_name`` is the repository name from the package attributes (optional).
- Examples::

pkg:vip/MGI/[email protected]
pkg:vip/OpenG.org/[email protected]
pkg:vip/JDP%20Science/[email protected]?repository_name=NI%20LabVIEW%20Tools%20Network

Other candidate types to define:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down