pypurl

패키지 URL을 구축/처리하는 경량 솔루션

현재 type 지원:

• GitHub
• Gitlab
• 비트버킷
• 파이파이
• npm
• 루비 보석

주요 개념:

각 구성 요소에 대한 정의는 다음과 같습니다.

계획

 this is the URL scheme with the constant value of "pkg". One of the 
primary reason for this single scheme is to facilitate the future official 
registration of the "pkg" scheme for package URLs. Required.

유형 (필수)

 the package "type" or package "protocol" such as github, bitbucket, 
maven, npm, nuget, gem, pypi, etc.

네임스페이스

 some name prefix such as a Maven groupid, a Docker image owner, a GitHub user 
or organization. Optional and type-specific.

이름 (필수)

 the name of the package.

버전(선택사항)

 the version of the package.

한정자(선택사항)

 extra qualifying data for a package such as an OS, architecture, a distro, etc. 
Type-specific.

하위 경로(선택 사항)

 extra subpath within a package, relative to the package root.

사용 방법:

pypurl/ $ pip install -e . # enter interpreter mode $ python # import main module >>> from pypurl .purl import Purl >>> p = Purl() # parse the Download URL to dictionary >>> p.durl_to_dict('https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip') {'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl '} # obtain the PURL from the Download URL only >>> durl = 'https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip' >>> p.durl_to_purl(durl) 'pkg:github/vBarbaros/ pypurl ' # obtain the PURL from the Download URL + version number/hash-commit >>> durl = 'https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip' >>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c') 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c' # obtain the PURL from the Download URL + version number/hash-commit + qualifiers >>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c', 'param1=one&param2=two&param3=three') 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three' # obtain the PURL from the Download URL + version number/hash-commit + qualifiers + subpath >>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c', 'param1=one&param2=two&param3=three', 'some/dummy/path') 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three#some/dummy/path' # parse the PURL containing main fields (+ version) to dictionary >>> purl = 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c' >>> p.purl_to_dict(purl) {'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl ', 'version': '244fd47e07d1004f0aed9c'} # parse the PURL containing all possible fields, to dictionary >>> purl = 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three#some/dummy/path' >>> p.purl_to_dict(purl) {'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl ', 'version': '244fd47e07d1004f0aed9c', 'qualifiers': 'param1=one&param2=two&param3=three', 'subpath': 'some/dummy/path'} ">

 # install the package
$ cd pypurl /
$ pip install -e .


# enter interpreter mode
$ python


# import main module
>>> from pypurl .purl import Purl
>>> p = Purl()


# parse the Download URL to dictionary
>>> p.durl_to_dict('https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip')
{'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl '}


# obtain the PURL from the Download URL only
>>> durl = 'https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip'
>>> p.durl_to_purl(durl)
'pkg:github/vBarbaros/ pypurl '


# obtain the PURL from the Download URL + version number/hash-commit
>>> durl = 'https://github.com/vBarbaros/pypurl/archive/refs/heads/main.zip'
>>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c')
'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c'


# obtain the PURL from the Download URL + version number/hash-commit + qualifiers
>>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c', 'param1=one&param2=two&param3=three')
'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three'


# obtain the PURL from the Download URL + version number/hash-commit + qualifiers + subpath
>>> p.durl_to_purl(durl, '244fd47e07d1004f0aed9c', 'param1=one&param2=two&param3=three', 'some/dummy/path')
'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three#some/dummy/path'


# parse the PURL containing main fields (+ version) to dictionary
>>> purl = 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c'
>>> p.purl_to_dict(purl)
{'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl ', 'version': '244fd47e07d1004f0aed9c'}


# parse the PURL containing all possible fields, to dictionary
>>> purl = 'pkg:github/vBarbaros/ pypurl @244fd47e07d1004f0aed9c?param1=one&param2=two&param3=three#some/dummy/path'
>>> p.purl_to_dict(purl)
{'scheme': 'pkg', 'type': 'github', 'namespace': 'vBarbaros', 'name': ' pypurl ', 'version': '244fd47e07d1004f0aed9c', 'qualifiers': 'param1=one&param2=two&param3=three', 'subpath': 'some/dummy/path'}

설치하다:

pypurl $ pip install -e .">

 $ cd pypurl 
$ pip install -e .

테스트 실행:

 $ python -m unittest tests/*.py

# Expected output
...
Ran 163 tests in 0.006s

OK

크레딧

이 모듈은 PURL을 사용하여 작업할 때 사람들이 겪었던 몇 가지 어려움을 기반으로 한 간단한 연습을 나타내지만, purl-specs 페이지는 이 모듈의 로드맵을 정의하는 데 도움이 되었습니다.

TODO

• 현재 구현된 저장소(GitHub, Gitlab, BitBucket, PyPi, npm, RubyGem) 외에 다른 저장소에 대한 지원 추가

특허

MIT © 빅터 바바로스, 2021