diff --git a/searchindex.js b/searchindex.js index bcc6949..4f75eeb 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["about/license", "contributing", "getting_started/developer-guide", "getting_started/index", "getting_started/installation", "getting_started/user-guide", "index", "source/modules", "source/oras", "source/oras.main", "source/oras.tests", "source/oras.utils"], "filenames": ["about/license.md", "contributing.md", "getting_started/developer-guide.md", "getting_started/index.md", "getting_started/installation.md", "getting_started/user-guide.md", "index.md", "source/modules.rst", "source/oras.rst", "source/oras.main.rst", "source/oras.tests.rst", "source/oras.utils.rst"], "titles": ["Apache License", "Contributing", "Developer Guide", "Guides", "Installation", "User Guide", "Oras Python", "oras", "oras package", "oras.main package", "oras.tests package", "oras.utils package"], "terms": {"_version": 0, "2": [0, 8], "0": [0, 5, 8, 11], "januari": 0, "2004": 0, "_": 0, "http": [0, 2, 4, 8], "www": [0, 8], "org": [0, 5], "term": 0, "condit": 0, "us": [0, 1, 2, 5, 8, 9, 11], "reproduct": 0, "distribut": [0, 5], "1": [0, 5, 8, 11], "definit": 0, "shall": 0, "mean": [0, 4, 5, 8, 9], "defin": [0, 5], "section": [0, 5, 8], "through": [0, 5], "9": [0, 5], "thi": [0, 1, 2, 5, 6, 8, 9, 10, 11], "document": [0, 1, 3], "licensor": 0, "copyright": [0, 1], "owner": [0, 1], "entiti": 0, "author": 0, "i": [0, 1, 2, 3, 4, 5, 6, 8, 11], "grant": 0, "legal": 0, "union": [0, 8], "act": 0, "all": [0, 1, 2, 4, 5, 8, 10], "other": [0, 1], "control": [0, 8], "ar": [0, 2, 4, 5, 8, 10], "under": [0, 2, 5], "common": 0, "For": [0, 1, 2, 5], "purpos": 0, "power": 0, "direct": [0, 8], "indirect": 0, "caus": 0, "manag": 0, "whether": [0, 11], "contract": 0, "otherwis": [0, 5, 11], "ii": 0, "ownership": 0, "fifti": 0, "percent": 0, "50": 0, "more": [0, 2, 5, 8], "outstand": 0, "share": [0, 8], "iii": 0, "benefici": 0, "you": [0, 1, 2, 3, 4, 5, 6], "your": [0, 1, 2, 3, 5], "an": [0, 1, 2, 5, 6, 8, 11], "individu": 0, "exercis": 0, "permiss": 0, "sourc": [0, 1, 2, 8, 9, 10, 11], "form": 0, "prefer": 0, "make": [0, 2, 4, 5, 11], "modif": 0, "includ": [0, 1, 2, 10], "limit": 0, "softwar": 0, "code": [0, 1, 3, 5, 8], "configur": [0, 8], "file": [0, 1, 2, 5, 6, 8, 9, 11], "object": [0, 3, 8, 9, 11], "ani": [0, 1, 2, 3, 4, 8], "result": 0, "from": [0, 2, 3, 4, 5, 8, 11], "mechan": 0, "transform": 0, "translat": 0, "compil": 0, "gener": [0, 1, 2, 8, 11], "convers": 0, "media": [0, 5, 8], "type": [0, 5, 8, 11], "work": [0, 5, 11], "authorship": 0, "made": 0, "avail": [0, 4], "indic": [0, 5, 8], "notic": 0, "attach": 0, "exampl": [0, 2, 5], "provid": [0, 1, 2, 4, 5, 7, 9, 11], "appendix": 0, "below": [0, 5, 6], "deriv": [0, 5], "base": [0, 5, 8, 9, 11], "which": [0, 5], "editori": [0, 1], "revis": 0, "annot": [0, 5, 7, 8, 10], "elabor": 0, "repres": 0, "whole": 0, "origin": [0, 8, 11], "remain": 0, "separ": 0, "mere": 0, "link": [0, 5, 6], "bind": 0, "name": [0, 5, 8, 9, 11], "interfac": 0, "thereof": 0, "contribut": [0, 2, 5, 6], "version": [0, 5, 7], "addit": [0, 5, 10], "intention": 0, "submit": 0, "inclus": 0, "behalf": 0, "electron": 0, "verbal": 0, "written": [0, 2], "commun": [0, 1, 2], "sent": 0, "its": [0, 11], "mail": 0, "list": [0, 5, 8, 9], "system": 0, "issu": [0, 1, 3, 5, 6], "track": 0, "discuss": [0, 1, 5], "improv": 0, "exclud": 0, "conspicu": 0, "mark": 0, "design": [0, 5], "write": [0, 2, 8, 11], "Not": 0, "contributor": [0, 2], "whom": 0, "ha": [0, 1, 5, 10], "been": [0, 1, 8], "receiv": 0, "subsequ": 0, "incorpor": 0, "within": [0, 1, 6, 11], "subject": [0, 7, 8], "each": [0, 5], "herebi": 0, "perpetu": 0, "worldwid": 0, "non": 0, "exclus": 0, "charg": 0, "royalti": 0, "free": 0, "irrevoc": 0, "reproduc": 0, "prepar": [0, 5, 8], "publicli": 0, "displai": 0, "perform": 0, "sublicens": 0, "3": [0, 8], "patent": 0, "except": 0, "state": 0, "have": [0, 1, 3, 4, 5, 8], "offer": 0, "sell": 0, "import": [0, 1, 2, 4, 5, 6], "transfer": 0, "where": [0, 4, 5], "appli": 0, "onli": [0, 2, 5], "those": [0, 8], "claim": 0, "necessarili": [0, 8], "infring": 0, "": [0, 1, 5], "alon": 0, "combin": 0, "wa": 0, "If": [0, 1, 2, 3, 5, 8, 9], "institut": 0, "litig": 0, "against": 0, "cross": 0, "counterclaim": 0, "lawsuit": 0, "alleg": 0, "constitut": 0, "contributori": 0, "termin": [0, 8], "date": 0, "4": [0, 5, 6, 8], "redistribut": 0, "mai": 0, "copi": [0, 8, 11], "medium": 0, "without": [0, 2, 5, 9, 10], "meet": 0, "follow": [0, 1, 2, 4, 5], "must": [0, 1, 5], "give": 0, "recipi": 0, "b": [0, 5], "modifi": 0, "carri": 0, "promin": 0, "chang": [0, 1, 2, 4], "c": [0, 11], "retain": 0, "trademark": 0, "attribut": 0, "do": [0, 2, 5, 8, 9, 11], "pertain": 0, "part": [0, 8], "d": [0, 5], "text": 0, "readabl": 0, "contain": [0, 2, 3, 5, 7, 9, 11], "least": 0, "one": [0, 5, 8, 11], "place": 0, "along": 0, "wherev": 0, "third": 0, "parti": 0, "normal": 0, "appear": [0, 5], "The": [0, 1, 2, 3, 4, 5, 8], "content": [0, 2, 5, 7], "inform": [0, 5, 8], "add": [0, 2, 4, 5, 7, 8, 11], "own": [0, 3, 5], "alongsid": [0, 5], "addendum": 0, "cannot": 0, "constru": 0, "statement": [0, 2], "differ": [0, 5], "compli": 0, "5": [0, 8], "submiss": 0, "unless": 0, "explicitli": 0, "notwithstand": 0, "abov": [0, 2, 5, 11], "noth": 0, "herein": 0, "supersed": 0, "agreement": 0, "execut": [0, 11], "regard": 0, "6": [0, 8], "doe": [0, 5, 11], "trade": 0, "servic": 0, "product": 0, "requir": [0, 2, 5], "reason": 0, "customari": 0, "describ": [0, 5], "7": [0, 8], "disclaim": 0, "warranti": 0, "applic": [0, 5, 11], "law": 0, "agre": 0, "AS": 0, "basi": 0, "OR": 0, "OF": 0, "kind": 0, "either": [0, 5], "express": 0, "impli": 0, "titl": [0, 5], "merchant": 0, "fit": 0, "FOR": 0, "A": [0, 5, 8, 11], "particular": [0, 5, 11], "sole": 0, "respons": [0, 5, 6, 8], "determin": [0, 8, 11], "appropri": [0, 5], "assum": [0, 5], "risk": 0, "associ": 0, "8": [0, 8], "liabil": 0, "In": [0, 2, 5], "event": 0, "theori": 0, "tort": 0, "neglig": 0, "deliber": 0, "grossli": 0, "liabl": 0, "damag": 0, "special": [0, 8], "incident": 0, "consequenti": 0, "charact": 0, "aris": 0, "out": [0, 5, 6], "inabl": 0, "loss": 0, "goodwil": 0, "stoppag": 0, "comput": 0, "failur": 0, "malfunct": 0, "commerci": 0, "even": 0, "advis": 0, "possibl": 0, "accept": 0, "while": [0, 5], "choos": 0, "fee": 0, "support": [0, 5, 8], "indemn": 0, "oblig": 0, "right": 0, "consist": [0, 5], "howev": 0, "indemnifi": 0, "defend": 0, "hold": [0, 11], "harmless": 0, "incur": 0, "assert": 0, "_end": 0, "AND": 0, "how": [0, 5], "To": [0, 2, 5, 6], "boilerpl": 0, "field": 0, "enclos": 0, "bracket": 0, "ref": [0, 11], "replac": 0, "identifi": [0, 5, 8], "don": [0, 1, 2, 5, 10], "t": [0, 1, 2, 4, 5, 8, 10], "should": [0, 1, 2, 3, 5, 8, 11], "comment": [0, 5], "syntax": [0, 2], "format": [0, 2], "we": [0, 1, 2, 4, 5, 8, 10, 11], "also": [0, 2, 4, 5, 8], "recommend": [0, 2, 5], "class": [0, 3, 8, 9, 11], "descript": 0, "same": [0, 2], "print": [0, 5, 8, 11], "page": 0, "easier": [0, 2], "identif": 0, "archiv": [0, 5, 11], "yyyi": 0, "complianc": 0, "obtain": 0, "see": [0, 1, 2, 5, 6], "specif": [0, 5, 8], "languag": [0, 2], "govern": 0, "when": [1, 2, 5, 8], "ora": [1, 2, 3, 4, 5], "python": [1, 2, 3, 5, 8], "properli": [1, 5], "gist": 1, "simpl": [1, 5, 8], "fix": [1, 2], "simpli": [1, 5], "explain": 1, "github": [1, 2, 4, 5], "pr": 1, "suffic": 1, "But": 1, "larger": 1, "enhanc": 1, "first": [1, 2, 5, 8], "project": [1, 2, 4, 5], "leader": 1, "develop": [1, 3, 4, 6], "can": [1, 2, 3, 4, 5, 8, 10, 11], "look": [1, 5, 8], "repositori": [1, 2, 4, 5, 8], "who": 1, "might": [1, 2, 5], "best": 1, "ping": 1, "jump": [1, 5], "channel": [1, 5], "cncf": 1, "slack": 1, "pleas": [1, 3, 5], "note": [1, 4, 5], "adopt": 1, "conduct": 1, "interact": [1, 2, 3, 4, 8], "member": 1, "user": [1, 2, 3, 6, 8, 9], "go": [1, 5], "main": [1, 2, 7, 8], "branch": 1, "exist": [1, 5, 8, 11], "style": 1, "preced": 1, "test": [1, 3, 4, 5, 7, 8], "lint": [1, 3, 4], "help": [1, 5], "black": [1, 2, 7, 8], "isort": [1, 2], "mypi": [1, 2], "pyflak": 1, "local": [1, 2, 3, 4], "step": [1, 5], "necessari": 1, "review": 1, "default": [1, 5, 7, 9, 11], "header": [1, 8], "new": [1, 5, 8], "major": 1, "changelog": 1, "md": [1, 2], "root": [1, 5, 11], "updat": [1, 2, 5, 8], "here": [1, 3, 5], "readm": 1, "final": [1, 5], "merg": 1, "done": [1, 4, 5, 8], "our": [1, 2, 5], "guid": [1, 6], "question": [1, 3, 5], "hesit": 1, "open": [1, 2, 5, 6, 8], "complex": 2, "like": [2, 5, 6], "registri": [2, 3, 6, 7, 8, 9, 10], "entri": 2, "haven": 2, "read": [2, 5, 8, 11], "want": [2, 5], "sdk": [2, 3, 5, 6], "client": [2, 3, 4, 6, 7, 11], "ll": 2, "creat": [2, 3, 6, 8, 11], "environ": [2, 5, 8], "auth": [2, 5, 7, 10], "docker": [2, 3, 5, 8, 9, 11], "rm": [2, 5], "p": [2, 5, 11], "5000": [2, 5, 6], "ghcr": [2, 5, 6], "io": [2, 5, 6, 8, 11], "latest": [2, 5], "And": [2, 5, 6], "ultim": 2, "script": 2, "sh": 2, "ipython": [2, 4], "somewher": 2, "pip": [2, 4, 6], "emb": 2, "last": 2, "line": [2, 5, 8, 11], "pytest": 2, "x": 2, "abl": [2, 3, 5], "debug": [2, 3, 7, 8], "action": [2, 5], "pre": 2, "commit": 2, "handl": [2, 5, 8], "flake8": 2, "setup": [2, 5, 8], "end": 2, "ensur": [2, 5, 8, 11], "larg": 2, "tool": [2, 5], "easi": [2, 5], "after": 2, "py": [2, 4, 5, 8], "r": [2, 11], "dev": [2, 5, 11], "txt": [2, 5, 6], "Then": [2, 5], "manual": [2, 4, 9], "check": [2, 5, 9], "ad": 2, "pass": [2, 5], "case": 2, "conflict": 2, "trim": 2, "trail": 2, "whitespac": 2, "mix": 2, "hook": 2, "so": [2, 4, 5], "never": 2, "flaw": 2, "courtesi": [2, 5, 8], "command": [2, 5, 8], "via": [2, 4, 8], "doc": [2, 3, 5], "folder": [2, 5], "most": [2, 5], "getting_start": 2, "eas": 2, "e": [2, 4, 5, 11], "g": [2, 5, 11], "mostli": 2, "everyth": [2, 4], "modul": [2, 4, 7], "markdown": 2, "need": [2, 5], "toctre": 2, "extra": [2, 4, 11], "newlin": 2, "space": 2, "index": [2, 8], "chosen": 2, "why": 2, "chose": 2, "over": 2, "restructur": 2, "built": 2, "sphinx": 2, "now": [2, 5], "cd": [2, 4], "requr": 2, "_build": 2, "html": 2, "enter": 2, "start": [2, 5, 6], "web": [2, 5], "server": [2, 5], "m": 2, "9999": 2, "browser": 2, "localhost": [2, 5, 6, 11], "render": 2, "api": [2, 8], "keep": 2, "demand": 2, "apidoc": 2, "remov": [2, 5, 8], "function": [2, 5, 8, 10, 11], "oci": [3, 6, 7, 11], "storag": [3, 6, 8], "easili": [3, 5], "pull": [3, 6, 7, 8, 10], "push": [3, 6, 7, 8, 10], "artifact": [3, 5, 6, 8], "build": [3, 4], "custom": [3, 8, 9], "primari": 3, "found": [3, 5, 11], "let": [3, 5], "u": [3, 5], "know": [3, 5], "instal": [3, 6], "pypi": 3, "tag": [3, 8, 10], "authent": [3, 8, 10], "run": [3, 4, 5, 8, 9, 10], "depend": [3, 4], "preview": 3, "docstr": 3, "clone": 4, "git": 4, "com": 4, "sever": 4, "mode": [4, 8, 11], "instead": [4, 5, 8, 9], "Or": [4, 5, 11], "ve": [4, 5], "librari": [4, 6], "immedi": 4, "live": 4, "dockerfil": 4, "allow": [5, 8], "tradit": 5, "set": [5, 8], "As": 5, "longer": 5, "walk": 5, "variou": 5, "point": 5, "relev": 5, "implement": 5, "learn": 5, "about": 5, "access": 5, "decid": 5, "context": [5, 11], "singl": [5, 8], "move": 5, "subclass": 5, "manifest": [5, 8, 10, 11], "layer": [5, 7, 8], "It": [5, 11], "often": 5, "deploi": 5, "detach": 5, "brave": 5, "try": [5, 8], "basic": [5, 6, 8, 10], "htpassword": 5, "bcrypt": 5, "htpasswd": 5, "cb": 5, "myuser": [5, 6], "mypass": 5, "login": [5, 6, 7, 8, 10], "won": 5, "token": [5, 8], "v": 5, "pwd": 5, "etc": [5, 8], "registry_auth": 5, "realm": 5, "path": [5, 8, 9, 10, 11], "mimic": 5, "myprovid": 5, "logout": [5, 7, 8, 10], "wrap": 5, "orascli": [5, 6, 7, 8], "self": 5, "set_basic_auth": [5, 7, 8], "usernam": [5, 6, 8, 9], "password": [5, 6, 8, 9], "current": 5, "just": 5, "idea": 5, "request": [5, 6, 7, 8], "config": [5, 8, 9, 11], "helper": [5, 11], "click": 5, "expand": 5, "empti": [5, 8], "size": [5, 7, 8, 11], "null": [5, 11], "conf": 5, "config_fil": 5, "manifestconfig": [5, 7, 8], "mediatyp": [5, 7, 8], "vnd": [5, 11], "unknown": 5, "v1": [5, 6, 8, 11], "json": [5, 11], "digest": [5, 7, 8], "sha256": [5, 11], "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855": 5, "alreadi": [5, 11], "tmp": [5, 6], "3891": 5, "1192142acbf7ac7578906407f5a28820c4ff69937000558613c2d9ec56db370a": 5, "befor": 5, "them": [5, 11], "popul": 5, "sai": 5, "blob": [5, 8, 11], "o": 5, "newlay": [5, 7, 8], "is_dir": [5, 8], "fals": [5, 8, 11], "media_typ": [5, 8], "dinosaur": [5, 6], "blobish": 5, "rel": [5, 8], "download": [5, 8], "basenam": 5, "flat": 5, "directori": [5, 8, 10, 11], "doesn": 5, "annotation_titl": 5, "append": 5, "next": 5, "what": 5, "full": [5, 8], "some": 5, "around": 5, "fairli": 5, "straight": 5, "forward": 5, "newmanifest": [5, 7, 8], "too": 5, "food": 5, "avocado": [5, 6], "previous": 5, "given": [5, 8, 11], "would": [5, 6], "upload_manifest": [5, 7, 8], "packag": [5, 7], "complet": [5, 8], "uniqu": [5, 8], "resourc": [5, 8], "get_tag": [5, 7, 8], "instanti": 5, "ask": 5, "get": [5, 6, 8, 10, 11], "conda": 5, "forg": 5, "could": [5, 8], "hostnam": [5, 8], "insecur": [5, 8], "number": [5, 8], "mirror": 5, "linux": 5, "aarch64": 5, "arrow": 5, "cpp": 5, "n": [5, 8], "1005": 5, "spec": 5, "veri": 5, "present": 5, "true": [5, 8, 11], "target": [5, 6, 8, 10, 11], "successfulli": [5, 6, 8], "201": [5, 6], "similar": [5, 9], "better": 5, "overrid": 5, "maintain": 5, "lookup": [5, 8], "conform": [5, 6], "expect": [5, 11], "group": 5, "pakag": 5, "q6amnrkq": 5, "16": 5, "tar": [5, 11], "gz": [5, 11], "imag": [5, 11], "gzip": 5, "sbom": 5, "cyclonedx": 5, "sinc": 5, "dictionari": [5, 8, 11], "kei": [5, 8], "upload": [5, 8], "decor": [5, 7], "ensure_contain": [5, 7, 8], "sy": 5, "def": 5, "dict": [5, 8, 9, 11], "none": [5, 8, 9, 11], "correspond": [5, 8], "annotset": 5, "item": 5, "logger": [5, 7], "exit": [5, 7, 8], "f": 5, "save": [5, 8], "compress": [5, 11], "blob_nam": 5, "cleanup_blob": 5, "isdir": 5, "util": [5, 7, 8], "make_targz": [5, 8, 11], "get_annot": [5, 7, 8], "upload_blob": [5, 7, 8], "_check_200_respons": 5, "cleanup": [5, 7, 8], "temporari": [5, 11], "targz": [5, 11], "manifest_annot": [5, 8], "config_annot": 5, "anoth": 5, "return": [5, 8, 11], "argument": [5, 8], "pars": [5, 7, 8, 10, 11], "remaind": 5, "between": 5, "usag": 5, "specifi": 5, "intuit": 5, "show": [5, 8], "workdir": [5, 8, 11], "log": [5, 8], "getlogg": 5, "__name__": 5, "get_oras_cli": 5, "method": 5, "oras_us": 5, "oras_pass": 5, "reg": 5, "els": 5, "miss": 5, "metadata": 5, "datatyp": 5, "warn": [5, 7, 8], "continu": 5, "extract": [5, 11], "info": [5, 7, 8], "uri": [5, 7, 8], "assembl": [5, 8], "datetim": 5, "oras_cli": 5, "listdir": 5, "filenam": [5, 8, 11], "logic": [5, 8, 10], "getsiz": 5, "join": 5, "byte": 5, "creationtim": 5, "str": [5, 8, 9, 11], "cach": 5, "simpler": 5, "than": 5, "re": [5, 6], "e5itvzfi": [5, 6], "imagin": 5, "retriev": [5, 8], "oper": [5, 11], "inspect": 5, "get_contain": [5, 7, 8], "three": 5, "get_manifest": [5, 7, 8], "organ": 5, "_organize_lay": 5, "find": [5, 11], "correct": 5, "get_blob": [5, 7, 8], "download_blob": [5, 7, 8], "stream": [5, 8], "extend": 5, "shown": 5, "abil": 5, "multipl": [5, 8], "select": 5, "download_lay": 5, "download_dir": 5, "desir": [5, 8], "intend": [5, 8], "call": [5, 8], "again": 5, "interest": 5, "presenc": 5, "string": [5, 8, 11], "price": 5, "come": 5, "googl": 5, "aw": 5, "practic": 5, "opencontain": 5, "rais": [5, 11], "error": [5, 7, 8, 11], "malici": 5, "outfil": 5, "sanitize_path": [5, 8, 11], "output": [5, 8, 11], "creativ": 5, "perhap": 5, "memori": 5, "further": 5, "11": 5, "expos": 5, "earlier": 5, "_download_blob": 5, "credenti": [5, 8, 10], "person": 5, "github_token": 5, "github_us": 5, "wolfv": 5, "64": 5, "xtensor": 5, "vsoch": 5, "excel": 5, "supplement": 5, "offici": 5, "ye": 5, "setup_logg": [5, 7, 8], "quiet": [5, 8], "my": 5, "messag": [5, 8], "verbos": 5, "unauthor": 5, "amazon": 5, "ecr": 5, "per": 5, "instruct": 5, "credsstor": 5, "extern": 5, "store": 5, "saniti": 5, "correctli": 5, "base64": 5, "encod": [5, 8], "actual": 5, "cool": 5, "think": 5, "happi": 5, "benefit": 5, "starter": 5, "task": 5, "welcom": 6, "enabl": [6, 11], "featur": 6, "process": 6, "apach": 6, "licens": 6, "subpackag": 7, "submodul": 7, "test_ora": [7, 8], "test_provid": [7, 8], "test_util": [7, 8], "fileio": [7, 8], "authhead": [7, 8], "get_basic_auth": [7, 8], "load_config": [7, 8], "parse_auth_head": [7, 8], "delete_tag": [7, 8], "set_token_auth": [7, 8], "api_prefix": [7, 8], "get_blob_url": [7, 8], "manifest_url": [7, 8], "tags_url": [7, 8], "upload_blob_url": [7, 8], "classretri": [7, 8], "retri": [7, 8], "default_v2_registri": [7, 8], "index_hostnam": [7, 8], "index_nam": [7, 8], "index_serv": [7, 8], "colorizingstreamhandl": [7, 8], "blue": [7, 8], "bold_seq": [7, 8], "color_seq": [7, 8], "cyan": [7, 8], "green": [7, 8], "magenta": [7, 8], "red": [7, 8], "reset_seq": [7, 8], "white": [7, 8], "yellow": [7, 8], "can_color_tti": [7, 8], "color": [7, 8], "emit": [7, 8], "is_tti": [7, 8], "handler": [7, 8], "locat": [7, 8], "progress": [7, 8], "set_level": [7, 8], "set_stream_handl": [7, 8], "shellcmd": [7, 8], "text_handl": [7, 8], "load": [7, 8, 9], "set_media_typ": [7, 8], "to_dict": [7, 8], "authenticate_request": [7, 8], "chunked_upload": [7, 8], "do_request": [7, 8], "put_upload": [7, 8], "request_anonymous_token": [7, 8], "reset_basic_auth": [7, 8], "set_head": [7, 8], "temporary_empty_config": [7, 8], "schema": 7, "dockercli": [8, 9], "test_basic_ora": [8, 10], "test_basic_push_pul": [8, 10], "test_directory_push_pul": [8, 10], "test_get_delete_tag": [8, 10], "test_get_many_tag": [8, 10], "test_login_logout": [8, 10], "test_annotated_registry_push": [8, 10], "test_parse_manifest": [8, 10], "test_sanitize_path": [8, 10], "test_copyfil": [8, 10], "test_get_tmpdir_tmpfil": [8, 10], "test_mkdir_p": [8, 10], "test_print_json": [8, 10], "test_split_path_and_cont": [8, 10], "test_workdir": [8, 10], "test_write_bad_json": [8, 10], "test_write_json": [8, 10], "test_write_read_fil": [8, 10], "pathandoptionalcont": [8, 11], "copyfil": [8, 11], "extract_targz": [8, 11], "get_file_hash": [8, 11], "get_siz": [8, 11], "get_tmpdir": [8, 11], "get_tmpfil": [8, 11], "is_within_directori": [8, 11], "mkdir_p": [8, 11], "print_json": [8, 11], "read_fil": [8, 11], "read_in_chunk": [8, 11], "read_json": [8, 11], "readlin": [8, 11], "recursive_find": [8, 11], "split_path_and_cont": [8, 11], "write_fil": [8, 11], "write_json": [8, 11], "append_url_param": [8, 11], "find_docker_config": [8, 11], "get_docker_cli": [8, 11], "iter_localhost": [8, 11], "paramet": [8, 9, 11], "account": [8, 9], "filesystem": 8, "option": [8, 11], "authheaderraw": 8, "piec": 8, "bool": [8, 11], "tls_verifi": [8, 11], "wrapper": 8, "isol": 8, "intern": 8, "standard": 8, "delet": [8, 10], "int": [8, 11], "password_stdin": 8, "config_path": 8, "input": 8, "verifi": 8, "tl": [8, 11], "arg": 8, "kwarg": [8, 11], "remot": 8, "bearer": 8, "return_item": 8, "param": [8, 11], "properti": 8, "prefix": [8, 11], "v2": 8, "endpoint": 8, "url": [8, 11], "compon": 8, "func": 8, "parent": [8, 11], "attempt": 8, "timeout": 8, "host": [8, 11], "scheme": 8, "nocolor": 8, "pathlib": 8, "textio": [8, 11], "_io": 8, "textiowrapp": 8, "stderr": 8, "w": [8, 11], "utf": 8, "use_thread": 8, "streamhandl": 8, "x1b": 8, "1m": 8, "dm": 8, "0m": 8, "tty": 8, "critic": 8, "record": 8, "logrecord": 8, "close": 8, "msg": 8, "level": 8, "return_cod": 8, "total": 8, "bar": 8, "count": 8, "stream_handl": 8, "consol": 8, "printshellcmd": 8, "stdout": 8, "init": 8, "shell": 8, "thread": 8, "valu": 8, "pair": 8, "blob_path": 8, "vari": 8, "represent": 8, "tupl": [8, 11], "isn": [8, 10], "originalrespons": 8, "chunk": [8, 11], "allowed_media_typ": 8, "overwrit": 8, "refresh_head": 8, "refresh": 8, "fetch": 8, "manifest_config_ref": 8, "outdir": [8, 11], "disable_path_valid": 8, "annotation_fil": 8, "refer": [8, 11], "put": 8, "h": 8, "fall": 8, "back": 8, "anonym": 8, "boolean": 8, "reset": 8, "do_chunk": 8, "1024": [8, 11], "approach": 8, "post": 8, "patch": 8, "insid": 9, "dockercfg_path": 9, "dockercfg_str": 9, "tmp_path": 10, "target_dir": 10, "creationg": 10, "mani": 10, "window": 10, "thei": 10, "usual": 10, "split": 10, "destin": 11, "forc": 11, "numeric_own": 11, "algorithm": 11, "hash": 11, "attributeerror": 11, "incorrect": 11, "suppli": 11, "tmpdir": 11, "suffix": 11, "extens": 11, "source_dir": 11, "dest_nam": 11, "akin": 11, "mkdir": 11, "json_obj": 11, "pretti": 11, "bufferedread": 11, "chunk_siz": 11, "1k": 11, "descriptor": 11, "stdin": 11, "pattern": 11, "match": 11, "yield": 11, "search": 11, "fnmatch": 11, "expected_dir": 11, "resolv": 11, "directli": 11, "child": 11, "outsid": 11, "happen": 11, "myconfig": 11, "dirnam": 11, "stuff": 11, "make_exec": 11, "filnam": 11, "alwai": 11, "127": 11}, "objects": {"": [[8, 0, 0, "-", "oras"]], "oras": [[8, 0, 0, "-", "auth"], [8, 0, 0, "-", "client"], [8, 0, 0, "-", "container"], [8, 0, 0, "-", "decorator"], [8, 0, 0, "-", "defaults"], [8, 0, 0, "-", "logger"], [9, 0, 0, "-", "main"], [8, 0, 0, "-", "oci"], [8, 0, 0, "-", "provider"], [8, 0, 0, "-", "schemas"], [10, 0, 0, "-", "tests"], [11, 0, 0, "-", "utils"], [8, 0, 0, "-", "version"]], "oras.auth": [[8, 1, 1, "", "authHeader"], [8, 2, 1, "", "get_basic_auth"], [8, 2, 1, "", "load_configs"], [8, 2, 1, "", "parse_auth_header"]], "oras.client": [[8, 1, 1, "", "OrasClient"]], "oras.client.OrasClient": [[8, 3, 1, "", "delete_tags"], [8, 3, 1, "", "get_tags"], [8, 3, 1, "", "login"], [8, 3, 1, "", "logout"], [8, 3, 1, "", "pull"], [8, 3, 1, "", "push"], [8, 3, 1, "", "set_basic_auth"], [8, 3, 1, "", "set_token_auth"], [8, 3, 1, "", "version"]], "oras.container": [[8, 1, 1, "", "Container"]], "oras.container.Container": [[8, 4, 1, "", "api_prefix"], [8, 3, 1, "", "get_blob_url"], [8, 3, 1, "", "manifest_url"], [8, 3, 1, "", "parse"], [8, 3, 1, "", "tags_url"], [8, 3, 1, "", "upload_blob_url"], [8, 4, 1, "", "uri"]], "oras.decorator": [[8, 1, 1, "", "Decorator"], [8, 1, 1, "", "classretry"], [8, 1, 1, "", "ensure_container"], [8, 2, 1, "", "retry"]], "oras.defaults": [[8, 1, 1, "", "registry"]], "oras.defaults.registry": [[8, 5, 1, "", "default_v2_registry"], [8, 5, 1, "", "index_hostname"], [8, 5, 1, "", "index_name"], [8, 5, 1, "", "index_server"]], "oras.logger": [[8, 1, 1, "", "ColorizingStreamHandler"], [8, 1, 1, "", "Logger"], [8, 2, 1, "", "setup_logger"]], "oras.logger.ColorizingStreamHandler": [[8, 5, 1, "", "BLACK"], [8, 5, 1, "", "BLUE"], [8, 5, 1, "", "BOLD_SEQ"], [8, 5, 1, "", "COLOR_SEQ"], [8, 5, 1, "", "CYAN"], [8, 5, 1, "", "GREEN"], [8, 5, 1, "", "MAGENTA"], [8, 5, 1, "", "RED"], [8, 5, 1, "", "RESET_SEQ"], [8, 5, 1, "", "WHITE"], [8, 5, 1, "", "YELLOW"], [8, 3, 1, "", "can_color_tty"], [8, 5, 1, "", "colors"], [8, 3, 1, "", "decorate"], [8, 3, 1, "", "emit"], [8, 4, 1, "", "is_tty"]], "oras.logger.Logger": [[8, 3, 1, "", "cleanup"], [8, 3, 1, "", "debug"], [8, 3, 1, "", "error"], [8, 3, 1, "", "exit"], [8, 3, 1, "", "handler"], [8, 3, 1, "", "info"], [8, 3, 1, "", "location"], [8, 3, 1, "", "progress"], [8, 3, 1, "", "set_level"], [8, 3, 1, "", "set_stream_handler"], [8, 3, 1, "", "shellcmd"], [8, 3, 1, "", "text_handler"], [8, 3, 1, "", "warning"]], "oras.main": [[9, 0, 0, "-", "login"]], "oras.main.login": [[9, 1, 1, "", "DockerClient"]], "oras.main.login.DockerClient": [[9, 3, 1, "", "login"]], "oras.oci": [[8, 1, 1, "", "Annotations"], [8, 1, 1, "", "Layer"], [8, 2, 1, "", "ManifestConfig"], [8, 2, 1, "", "NewLayer"], [8, 2, 1, "", "NewManifest"]], "oras.oci.Annotations": [[8, 3, 1, "", "add"], [8, 3, 1, "", "get_annotations"], [8, 3, 1, "", "load"]], "oras.oci.Layer": [[8, 3, 1, "", "set_media_type"], [8, 3, 1, "", "to_dict"]], "oras.provider": [[8, 1, 1, "", "Registry"], [8, 1, 1, "", "Subject"], [8, 2, 1, "", "temporary_empty_config"]], "oras.provider.Registry": [[8, 3, 1, "", "authenticate_request"], [8, 3, 1, "", "chunked_upload"], [8, 3, 1, "", "delete_tag"], [8, 3, 1, "", "do_request"], [8, 3, 1, "", "download_blob"], [8, 3, 1, "", "get_blob"], [8, 3, 1, "", "get_container"], [8, 3, 1, "", "get_manifest"], [8, 3, 1, "", "get_tags"], [8, 3, 1, "", "load_configs"], [8, 3, 1, "", "logout"], [8, 3, 1, "", "pull"], [8, 3, 1, "", "push"], [8, 3, 1, "", "put_upload"], [8, 3, 1, "", "request_anonymous_token"], [8, 3, 1, "", "reset_basic_auth"], [8, 3, 1, "", "set_basic_auth"], [8, 3, 1, "", "set_header"], [8, 3, 1, "", "set_token_auth"], [8, 3, 1, "", "upload_blob"], [8, 3, 1, "", "upload_manifest"]], "oras.provider.Subject": [[8, 5, 1, "", "digest"], [8, 5, 1, "", "mediaType"], [8, 5, 1, "", "size"]], "oras.tests": [[10, 0, 0, "-", "test_oras"], [10, 0, 0, "-", "test_provider"], [10, 0, 0, "-", "test_utils"]], "oras.tests.test_oras": [[10, 2, 1, "", "test_basic_oras"], [10, 2, 1, "", "test_basic_push_pull"], [10, 2, 1, "", "test_directory_push_pull"], [10, 2, 1, "", "test_get_delete_tags"], [10, 2, 1, "", "test_get_many_tags"], [10, 2, 1, "", "test_login_logout"]], "oras.tests.test_provider": [[10, 2, 1, "", "test_annotated_registry_push"], [10, 2, 1, "", "test_parse_manifest"], [10, 2, 1, "", "test_sanitize_path"]], "oras.tests.test_utils": [[10, 2, 1, "", "test_copyfile"], [10, 2, 1, "", "test_get_tmpdir_tmpfile"], [10, 2, 1, "", "test_mkdir_p"], [10, 2, 1, "", "test_print_json"], [10, 2, 1, "", "test_split_path_and_content"], [10, 2, 1, "", "test_workdir"], [10, 2, 1, "", "test_write_bad_json"], [10, 2, 1, "", "test_write_json"], [10, 2, 1, "", "test_write_read_files"]], "oras.utils": [[11, 0, 0, "-", "fileio"], [11, 0, 0, "-", "request"]], "oras.utils.fileio": [[11, 1, 1, "", "PathAndOptionalContent"], [11, 2, 1, "", "copyfile"], [11, 2, 1, "", "extract_targz"], [11, 2, 1, "", "get_file_hash"], [11, 2, 1, "", "get_size"], [11, 2, 1, "", "get_tmpdir"], [11, 2, 1, "", "get_tmpfile"], [11, 2, 1, "", "is_within_directory"], [11, 2, 1, "", "make_targz"], [11, 2, 1, "", "mkdir_p"], [11, 2, 1, "", "print_json"], [11, 2, 1, "", "read_file"], [11, 2, 1, "", "read_in_chunks"], [11, 2, 1, "", "read_json"], [11, 2, 1, "", "readline"], [11, 2, 1, "", "recursive_find"], [11, 2, 1, "", "sanitize_path"], [11, 2, 1, "", "split_path_and_content"], [11, 2, 1, "", "workdir"], [11, 2, 1, "", "write_file"], [11, 2, 1, "", "write_json"]], "oras.utils.request": [[11, 2, 1, "", "append_url_params"], [11, 2, 1, "", "find_docker_config"], [11, 2, 1, "", "get_docker_client"], [11, 2, 1, "", "iter_localhosts"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:function", "3": "py:method", "4": "py:property", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "function", "Python function"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"apach": 0, "licens": 0, "contribut": 1, "pull": [1, 5], "request": [1, 11], "process": 1, "develop": [2, 5], "guid": [2, 3, 5], "run": 2, "test": [2, 10], "code": 2, "lint": 2, "document": 2, "instal": [2, 4], "depend": 2, "build": 2, "preview": 2, "docstr": 2, "pypi": 4, "docker": 4, "contain": [4, 8], "user": 5, "local": 5, "registri": 5, "creat": 5, "client": [5, 8], "class": 5, "oci": [5, 8], "object": 5, "tag": 5, "push": 5, "interact": 5, "authent": 5, "debug": 5, "custom": 5, "ora": [6, 7, 8, 9, 10, 11], "python": 6, "api": 6, "packag": [8, 9, 10, 11], "subpackag": 8, "submodul": [8, 9, 10, 11], "auth": 8, "modul": [8, 9, 10, 11], "decor": 8, "default": 8, "logger": 8, "provid": 8, "schema": 8, "version": 8, "content": [8, 9, 10, 11], "main": 9, "login": 9, "test_ora": 10, "test_provid": 10, "test_util": 10, "util": 11, "fileio": 11, "exampl": 11}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "nbsphinx": 4, "sphinx": 60}, "alltitles": {"Developer Guide": [[2, "developer-guide"]], "Running Tests": [[2, "running-tests"]], "Code Linting": [[2, "code-linting"]], "Documentation": [[2, "documentation"]], "Install Dependencies and Build": [[2, "install-dependencies-and-build"]], "Preview Documentation": [[2, "preview-documentation"]], "Docstrings": [[2, "docstrings"]], "Apache License": [[0, "apache-license"]], "Contributing": [[1, "contributing"]], "Pull Request Process": [[1, "pull-request-process"]], "Installation": [[4, "installation"]], "Pypi": [[4, "pypi"]], "Docker Container": [[4, "docker-container"]], "User Guide": [[5, "user-guide"]], "Local Development Registry": [[5, "local-development-registry"]], "Create a Client Class": [[5, "create-a-client-class"]], "Creating OCI Objects": [[5, "creating-oci-objects"]], "Tags": [[5, "tags"]], "Push Interactions": [[5, "push-interactions"]], "Pull Interactions": [[5, "pull-interactions"]], "Authentication": [[5, "authentication"]], "Debugging": [[5, "debugging"]], "Custom Clients": [[5, "custom-clients"]], "Guides": [[3, "guides"]], "oras.tests package": [[10, "oras-tests-package"]], "Submodules": [[10, "submodules"], [11, "submodules"], [9, "submodules"], [8, "submodules"]], "oras.tests.test_oras module": [[10, "module-oras.tests.test_oras"]], "oras.tests.test_provider module": [[10, "module-oras.tests.test_provider"]], "oras.tests.test_utils module": [[10, "module-oras.tests.test_utils"]], "Module contents": [[10, "module-oras.tests"], [11, "module-oras.utils"], [9, "module-oras.main"], [8, "module-oras"]], "oras.utils package": [[11, "oras-utils-package"]], "oras.utils.fileio module": [[11, "module-oras.utils.fileio"]], "Examples": [[11, "examples"]], "oras.utils.request module": [[11, "module-oras.utils.request"]], "oras.main package": [[9, "oras-main-package"]], "oras.main.login module": [[9, "module-oras.main.login"]], "oras": [[7, "oras"]], "Oras Python": [[6, "oras-python"]], "API": [[6, null]], "oras package": [[8, "oras-package"]], "Subpackages": [[8, "subpackages"]], "oras.auth module": [[8, "module-oras.auth"]], "oras.client module": [[8, "module-oras.client"]], "oras.container module": [[8, "module-oras.container"]], "oras.decorator module": [[8, "module-oras.decorator"]], "oras.defaults module": [[8, "module-oras.defaults"]], "oras.logger module": [[8, "module-oras.logger"]], "oras.oci module": [[8, "module-oras.oci"]], "oras.provider module": [[8, "module-oras.provider"]], "oras.schemas module": [[8, "module-oras.schemas"]], "oras.version module": [[8, "module-oras.version"]]}, "indexentries": {"annotations (class in oras.oci)": [[8, "oras.oci.Annotations"]], "black (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BLACK"]], "blue (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BLUE"]], "bold_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BOLD_SEQ"]], "color_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.COLOR_SEQ"]], "cyan (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.CYAN"]], "colorizingstreamhandler (class in oras.logger)": [[8, "oras.logger.ColorizingStreamHandler"]], "container (class in oras.container)": [[8, "oras.container.Container"]], "decorator (class in oras.decorator)": [[8, "oras.decorator.Decorator"]], "green (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.GREEN"]], "layer (class in oras.oci)": [[8, "oras.oci.Layer"]], "logger (class in oras.logger)": [[8, "oras.logger.Logger"]], "magenta (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.MAGENTA"]], "manifestconfig() (in module oras.oci)": [[8, "oras.oci.ManifestConfig"]], "newlayer() (in module oras.oci)": [[8, "oras.oci.NewLayer"]], "newmanifest() (in module oras.oci)": [[8, "oras.oci.NewManifest"]], "orasclient (class in oras.client)": [[8, "oras.client.OrasClient"]], "red (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.RED"]], "reset_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.RESET_SEQ"]], "registry (class in oras.provider)": [[8, "oras.provider.Registry"]], "subject (class in oras.provider)": [[8, "oras.provider.Subject"]], "white (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.WHITE"]], "yellow (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.YELLOW"]], "add() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.add"]], "api_prefix (oras.container.container property)": [[8, "oras.container.Container.api_prefix"]], "authheader (class in oras.auth)": [[8, "oras.auth.authHeader"]], "authenticate_request() (oras.provider.registry method)": [[8, "oras.provider.Registry.authenticate_request"]], "can_color_tty() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.can_color_tty"]], "chunked_upload() (oras.provider.registry method)": [[8, "oras.provider.Registry.chunked_upload"]], "classretry (class in oras.decorator)": [[8, "oras.decorator.classretry"]], "cleanup() (oras.logger.logger method)": [[8, "oras.logger.Logger.cleanup"]], "colors (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.colors"]], "debug() (oras.logger.logger method)": [[8, "oras.logger.Logger.debug"]], "decorate() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.decorate"]], "default_v2_registry (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.default_v2_registry"]], "delete_tag() (oras.provider.registry method)": [[8, "oras.provider.Registry.delete_tag"]], "delete_tags() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.delete_tags"]], "digest (oras.provider.subject attribute)": [[8, "oras.provider.Subject.digest"]], "do_request() (oras.provider.registry method)": [[8, "oras.provider.Registry.do_request"]], "download_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.download_blob"]], "emit() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.emit"]], "ensure_container (class in oras.decorator)": [[8, "oras.decorator.ensure_container"]], "error() (oras.logger.logger method)": [[8, "oras.logger.Logger.error"]], "exit() (oras.logger.logger method)": [[8, "oras.logger.Logger.exit"]], "get_annotations() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.get_annotations"]], "get_basic_auth() (in module oras.auth)": [[8, "oras.auth.get_basic_auth"]], "get_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_blob"]], "get_blob_url() (oras.container.container method)": [[8, "oras.container.Container.get_blob_url"]], "get_container() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_container"]], "get_manifest() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_manifest"]], "get_tags() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.get_tags"]], "get_tags() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_tags"]], "handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.handler"]], "index_hostname (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_hostname"]], "index_name (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_name"]], "index_server (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_server"]], "info() (oras.logger.logger method)": [[8, "oras.logger.Logger.info"]], "is_tty (oras.logger.colorizingstreamhandler property)": [[8, "oras.logger.ColorizingStreamHandler.is_tty"]], "load() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.load"]], "load_configs() (in module oras.auth)": [[8, "oras.auth.load_configs"]], "load_configs() (oras.provider.registry method)": [[8, "oras.provider.Registry.load_configs"]], "location() (oras.logger.logger method)": [[8, "oras.logger.Logger.location"]], "login() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.login"]], "logout() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.logout"]], "logout() (oras.provider.registry method)": [[8, "oras.provider.Registry.logout"]], "manifest_url() (oras.container.container method)": [[8, "oras.container.Container.manifest_url"]], "mediatype (oras.provider.subject attribute)": [[8, "oras.provider.Subject.mediaType"]], "module": [[8, "module-oras"], [8, "module-oras.auth"], [8, "module-oras.client"], [8, "module-oras.container"], [8, "module-oras.decorator"], [8, "module-oras.defaults"], [8, "module-oras.logger"], [8, "module-oras.oci"], [8, "module-oras.provider"], [8, "module-oras.schemas"], [8, "module-oras.version"], [9, "module-oras.main"], [9, "module-oras.main.login"], [10, "module-oras.tests"], [10, "module-oras.tests.test_oras"], [10, "module-oras.tests.test_provider"], [10, "module-oras.tests.test_utils"], [11, "module-oras.utils"], [11, "module-oras.utils.fileio"], [11, "module-oras.utils.request"]], "oras": [[8, "module-oras"]], "oras.auth": [[8, "module-oras.auth"]], "oras.client": [[8, "module-oras.client"]], "oras.container": [[8, "module-oras.container"]], "oras.decorator": [[8, "module-oras.decorator"]], "oras.defaults": [[8, "module-oras.defaults"]], "oras.logger": [[8, "module-oras.logger"]], "oras.oci": [[8, "module-oras.oci"]], "oras.provider": [[8, "module-oras.provider"]], "oras.schemas": [[8, "module-oras.schemas"]], "oras.version": [[8, "module-oras.version"]], "parse() (oras.container.container method)": [[8, "oras.container.Container.parse"]], "parse_auth_header() (in module oras.auth)": [[8, "oras.auth.parse_auth_header"]], "progress() (oras.logger.logger method)": [[8, "oras.logger.Logger.progress"]], "pull() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.pull"]], "pull() (oras.provider.registry method)": [[8, "oras.provider.Registry.pull"]], "push() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.push"]], "push() (oras.provider.registry method)": [[8, "oras.provider.Registry.push"]], "put_upload() (oras.provider.registry method)": [[8, "oras.provider.Registry.put_upload"]], "registry (class in oras.defaults)": [[8, "oras.defaults.registry"]], "request_anonymous_token() (oras.provider.registry method)": [[8, "oras.provider.Registry.request_anonymous_token"]], "reset_basic_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.reset_basic_auth"]], "retry() (in module oras.decorator)": [[8, "oras.decorator.retry"]], "set_basic_auth() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.set_basic_auth"]], "set_basic_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_basic_auth"]], "set_header() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_header"]], "set_level() (oras.logger.logger method)": [[8, "oras.logger.Logger.set_level"]], "set_media_type() (oras.oci.layer method)": [[8, "oras.oci.Layer.set_media_type"]], "set_stream_handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.set_stream_handler"]], "set_token_auth() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.set_token_auth"]], "set_token_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_token_auth"]], "setup_logger() (in module oras.logger)": [[8, "oras.logger.setup_logger"]], "shellcmd() (oras.logger.logger method)": [[8, "oras.logger.Logger.shellcmd"]], "size (oras.provider.subject attribute)": [[8, "oras.provider.Subject.size"]], "tags_url() (oras.container.container method)": [[8, "oras.container.Container.tags_url"]], "temporary_empty_config() (in module oras.provider)": [[8, "oras.provider.temporary_empty_config"]], "text_handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.text_handler"]], "to_dict() (oras.oci.layer method)": [[8, "oras.oci.Layer.to_dict"]], "upload_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.upload_blob"]], "upload_blob_url() (oras.container.container method)": [[8, "oras.container.Container.upload_blob_url"]], "upload_manifest() (oras.provider.registry method)": [[8, "oras.provider.Registry.upload_manifest"]], "uri (oras.container.container property)": [[8, "oras.container.Container.uri"]], "version() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.version"]], "warning() (oras.logger.logger method)": [[8, "oras.logger.Logger.warning"]], "dockerclient (class in oras.main.login)": [[9, "oras.main.login.DockerClient"]], "login() (oras.main.login.dockerclient method)": [[9, "oras.main.login.DockerClient.login"]], "oras.main": [[9, "module-oras.main"]], "oras.main.login": [[9, "module-oras.main.login"]], "oras.tests": [[10, "module-oras.tests"]], "oras.tests.test_oras": [[10, "module-oras.tests.test_oras"]], "oras.tests.test_provider": [[10, "module-oras.tests.test_provider"]], "oras.tests.test_utils": [[10, "module-oras.tests.test_utils"]], "test_annotated_registry_push() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_annotated_registry_push"]], "test_basic_oras() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_basic_oras"]], "test_basic_push_pull() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_basic_push_pull"]], "test_copyfile() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_copyfile"]], "test_directory_push_pull() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_directory_push_pull"]], "test_get_delete_tags() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_get_delete_tags"]], "test_get_many_tags() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_get_many_tags"]], "test_get_tmpdir_tmpfile() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_get_tmpdir_tmpfile"]], "test_login_logout() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_login_logout"]], "test_mkdir_p() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_mkdir_p"]], "test_parse_manifest() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_parse_manifest"]], "test_print_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_print_json"]], "test_sanitize_path() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_sanitize_path"]], "test_split_path_and_content() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_split_path_and_content"]], "test_workdir() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_workdir"]], "test_write_bad_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_bad_json"]], "test_write_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_json"]], "test_write_read_files() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_read_files"]], "pathandoptionalcontent (class in oras.utils.fileio)": [[11, "oras.utils.fileio.PathAndOptionalContent"]], "append_url_params() (in module oras.utils.request)": [[11, "oras.utils.request.append_url_params"]], "copyfile() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.copyfile"]], "extract_targz() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.extract_targz"]], "find_docker_config() (in module oras.utils.request)": [[11, "oras.utils.request.find_docker_config"]], "get_docker_client() (in module oras.utils.request)": [[11, "oras.utils.request.get_docker_client"]], "get_file_hash() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_file_hash"]], "get_size() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_size"]], "get_tmpdir() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_tmpdir"]], "get_tmpfile() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_tmpfile"]], "is_within_directory() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.is_within_directory"]], "iter_localhosts() (in module oras.utils.request)": [[11, "oras.utils.request.iter_localhosts"]], "make_targz() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.make_targz"]], "mkdir_p() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.mkdir_p"]], "oras.utils": [[11, "module-oras.utils"]], "oras.utils.fileio": [[11, "module-oras.utils.fileio"]], "oras.utils.request": [[11, "module-oras.utils.request"]], "print_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.print_json"]], "read_file() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_file"]], "read_in_chunks() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_in_chunks"]], "read_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_json"]], "readline() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.readline"]], "recursive_find() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.recursive_find"]], "sanitize_path() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.sanitize_path"]], "split_path_and_content() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.split_path_and_content"]], "workdir() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.workdir"]], "write_file() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.write_file"]], "write_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.write_json"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["about/license", "contributing", "getting_started/developer-guide", "getting_started/index", "getting_started/installation", "getting_started/user-guide", "index", "source/modules", "source/oras", "source/oras.main", "source/oras.tests", "source/oras.utils"], "filenames": ["about/license.md", "contributing.md", "getting_started/developer-guide.md", "getting_started/index.md", "getting_started/installation.md", "getting_started/user-guide.md", "index.md", "source/modules.rst", "source/oras.rst", "source/oras.main.rst", "source/oras.tests.rst", "source/oras.utils.rst"], "titles": ["Apache License", "Contributing", "Developer Guide", "Guides", "Installation", "User Guide", "Oras Python", "oras", "oras package", "oras.main package", "oras.tests package", "oras.utils package"], "terms": {"_version": 0, "2": [0, 8], "0": [0, 5, 8, 11], "januari": 0, "2004": 0, "_": 0, "http": [0, 2, 4, 8], "www": [0, 8], "org": [0, 5], "term": 0, "condit": 0, "us": [0, 1, 2, 5, 8, 9, 11], "reproduct": 0, "distribut": [0, 5], "1": [0, 5, 8, 11], "definit": 0, "shall": 0, "mean": [0, 4, 5, 8, 9], "defin": [0, 5], "section": [0, 5, 8], "through": [0, 5], "9": [0, 5], "thi": [0, 1, 2, 5, 6, 8, 9, 10, 11], "document": [0, 1, 3], "licensor": 0, "copyright": [0, 1], "owner": [0, 1], "entiti": 0, "author": 0, "i": [0, 1, 2, 3, 4, 5, 6, 8, 11], "grant": 0, "legal": 0, "union": [0, 8], "act": 0, "all": [0, 1, 2, 4, 5, 8, 10], "other": [0, 1], "control": [0, 8], "ar": [0, 2, 4, 5, 8, 10], "under": [0, 2, 5], "common": 0, "For": [0, 1, 2, 5], "purpos": 0, "power": 0, "direct": [0, 8], "indirect": 0, "caus": 0, "manag": 0, "whether": [0, 11], "contract": 0, "otherwis": [0, 5, 11], "ii": 0, "ownership": 0, "fifti": 0, "percent": 0, "50": 0, "more": [0, 2, 5, 8], "outstand": 0, "share": [0, 8], "iii": 0, "benefici": 0, "you": [0, 1, 2, 3, 4, 5, 6], "your": [0, 1, 2, 3, 5], "an": [0, 1, 2, 5, 6, 8, 11], "individu": 0, "exercis": 0, "permiss": 0, "sourc": [0, 1, 2, 8, 9, 10, 11], "form": 0, "prefer": 0, "make": [0, 2, 4, 5, 11], "modif": 0, "includ": [0, 1, 2, 10], "limit": 0, "softwar": 0, "code": [0, 1, 3, 5, 8], "configur": [0, 8], "file": [0, 1, 2, 5, 6, 8, 9, 11], "object": [0, 3, 8, 9, 11], "ani": [0, 1, 2, 3, 4, 8], "result": 0, "from": [0, 2, 3, 4, 5, 8, 11], "mechan": 0, "transform": 0, "translat": 0, "compil": 0, "gener": [0, 1, 2, 8, 11], "convers": 0, "media": [0, 5, 8], "type": [0, 5, 8, 11], "work": [0, 5, 11], "authorship": 0, "made": 0, "avail": [0, 4], "indic": [0, 5, 8], "notic": 0, "attach": 0, "exampl": [0, 2, 5], "provid": [0, 1, 2, 4, 5, 7, 9, 11], "appendix": 0, "below": [0, 5, 6], "deriv": [0, 5], "base": [0, 5, 8, 9, 11], "which": [0, 5], "editori": [0, 1], "revis": 0, "annot": [0, 5, 7, 8, 10], "elabor": 0, "repres": 0, "whole": 0, "origin": [0, 8, 11], "remain": 0, "separ": 0, "mere": 0, "link": [0, 5, 6], "bind": 0, "name": [0, 5, 8, 9, 11], "interfac": 0, "thereof": 0, "contribut": [0, 2, 5, 6], "version": [0, 5, 7], "addit": [0, 5, 10], "intention": 0, "submit": 0, "inclus": 0, "behalf": 0, "electron": 0, "verbal": 0, "written": [0, 2], "commun": [0, 1, 2], "sent": 0, "its": [0, 11], "mail": 0, "list": [0, 5, 8, 9], "system": 0, "issu": [0, 1, 3, 5, 6], "track": 0, "discuss": [0, 1, 5], "improv": 0, "exclud": 0, "conspicu": 0, "mark": 0, "design": [0, 5], "write": [0, 2, 8, 11], "Not": 0, "contributor": [0, 2], "whom": 0, "ha": [0, 1, 5, 10], "been": [0, 1, 8], "receiv": 0, "subsequ": 0, "incorpor": 0, "within": [0, 1, 6, 11], "subject": [0, 7, 8], "each": [0, 5], "herebi": 0, "perpetu": 0, "worldwid": 0, "non": 0, "exclus": 0, "charg": 0, "royalti": 0, "free": 0, "irrevoc": 0, "reproduc": 0, "prepar": [0, 5, 8], "publicli": 0, "displai": 0, "perform": 0, "sublicens": 0, "3": [0, 8], "patent": 0, "except": 0, "state": 0, "have": [0, 1, 3, 4, 5, 8], "offer": 0, "sell": 0, "import": [0, 1, 2, 4, 5, 6], "transfer": 0, "where": [0, 4, 5], "appli": 0, "onli": [0, 2, 5], "those": [0, 8], "claim": 0, "necessarili": [0, 8], "infring": 0, "": [0, 1, 5], "alon": 0, "combin": 0, "wa": 0, "If": [0, 1, 2, 3, 5, 8, 9], "institut": 0, "litig": 0, "against": 0, "cross": 0, "counterclaim": 0, "lawsuit": 0, "alleg": 0, "constitut": 0, "contributori": 0, "termin": [0, 8], "date": 0, "4": [0, 5, 6, 8], "redistribut": 0, "mai": 0, "copi": [0, 8, 11], "medium": 0, "without": [0, 2, 5, 9, 10], "meet": 0, "follow": [0, 1, 2, 4, 5], "must": [0, 1, 5], "give": 0, "recipi": 0, "b": [0, 5], "modifi": 0, "carri": 0, "promin": 0, "chang": [0, 1, 2, 4], "c": [0, 11], "retain": 0, "trademark": 0, "attribut": 0, "do": [0, 2, 5, 8, 9, 11], "pertain": 0, "part": [0, 8], "d": [0, 5], "text": 0, "readabl": 0, "contain": [0, 2, 3, 5, 7, 9, 11], "least": 0, "one": [0, 5, 8, 11], "place": 0, "along": 0, "wherev": 0, "third": 0, "parti": 0, "normal": 0, "appear": [0, 5], "The": [0, 1, 2, 3, 4, 5, 8], "content": [0, 2, 5, 7], "inform": [0, 5, 8], "add": [0, 2, 4, 5, 7, 8, 11], "own": [0, 3, 5], "alongsid": [0, 5], "addendum": 0, "cannot": 0, "constru": 0, "statement": [0, 2], "differ": [0, 5], "compli": 0, "5": [0, 8], "submiss": 0, "unless": 0, "explicitli": 0, "notwithstand": 0, "abov": [0, 2, 5, 11], "noth": 0, "herein": 0, "supersed": 0, "agreement": 0, "execut": [0, 11], "regard": 0, "6": [0, 8], "doe": [0, 5, 11], "trade": 0, "servic": 0, "product": 0, "requir": [0, 2, 5], "reason": 0, "customari": 0, "describ": [0, 5], "7": [0, 8], "disclaim": 0, "warranti": 0, "applic": [0, 5, 11], "law": 0, "agre": 0, "AS": 0, "basi": 0, "OR": 0, "OF": 0, "kind": 0, "either": [0, 5], "express": 0, "impli": 0, "titl": [0, 5], "merchant": 0, "fit": 0, "FOR": 0, "A": [0, 5, 8, 11], "particular": [0, 5, 11], "sole": 0, "respons": [0, 5, 6, 8], "determin": [0, 8, 11], "appropri": [0, 5], "assum": [0, 5], "risk": 0, "associ": 0, "8": [0, 8], "liabil": 0, "In": [0, 2, 5], "event": 0, "theori": 0, "tort": 0, "neglig": 0, "deliber": 0, "grossli": 0, "liabl": 0, "damag": 0, "special": [0, 8], "incident": 0, "consequenti": 0, "charact": 0, "aris": 0, "out": [0, 5, 6], "inabl": 0, "loss": 0, "goodwil": 0, "stoppag": 0, "comput": 0, "failur": 0, "malfunct": 0, "commerci": 0, "even": 0, "advis": 0, "possibl": 0, "accept": 0, "while": [0, 5], "choos": 0, "fee": 0, "support": [0, 5, 8], "indemn": 0, "oblig": 0, "right": 0, "consist": [0, 5], "howev": 0, "indemnifi": 0, "defend": 0, "hold": [0, 11], "harmless": 0, "incur": 0, "assert": 0, "_end": 0, "AND": 0, "how": [0, 5], "To": [0, 2, 5, 6], "boilerpl": 0, "field": 0, "enclos": 0, "bracket": 0, "ref": [0, 11], "replac": 0, "identifi": [0, 5, 8], "don": [0, 1, 2, 5, 10], "t": [0, 1, 2, 4, 5, 8, 10], "should": [0, 1, 2, 3, 5, 8, 11], "comment": [0, 5], "syntax": [0, 2], "format": [0, 2], "we": [0, 1, 2, 4, 5, 8, 10, 11], "also": [0, 2, 4, 5, 8], "recommend": [0, 2, 5], "class": [0, 3, 8, 9, 11], "descript": 0, "same": [0, 2], "print": [0, 5, 8, 11], "page": 0, "easier": [0, 2], "identif": 0, "archiv": [0, 5, 11], "yyyi": 0, "complianc": 0, "obtain": 0, "see": [0, 1, 2, 5, 6], "specif": [0, 5, 8], "languag": [0, 2], "govern": 0, "when": [1, 2, 5, 8], "ora": [1, 2, 3, 4, 5], "python": [1, 2, 3, 5, 8], "properli": [1, 5], "gist": 1, "simpl": [1, 5, 8], "fix": [1, 2], "simpli": [1, 5], "explain": 1, "github": [1, 2, 4, 5], "pr": 1, "suffic": 1, "But": 1, "larger": 1, "enhanc": 1, "first": [1, 2, 5, 8], "project": [1, 2, 4, 5], "leader": 1, "develop": [1, 3, 4, 6], "can": [1, 2, 3, 4, 5, 8, 10, 11], "look": [1, 5, 8], "repositori": [1, 2, 4, 5, 8], "who": 1, "might": [1, 2, 5], "best": 1, "ping": 1, "jump": [1, 5], "channel": [1, 5], "cncf": 1, "slack": 1, "pleas": [1, 3, 5], "note": [1, 4, 5], "adopt": 1, "conduct": 1, "interact": [1, 2, 3, 4, 8], "member": 1, "user": [1, 2, 3, 6, 8, 9], "go": [1, 5], "main": [1, 2, 7, 8], "branch": 1, "exist": [1, 5, 8, 11], "style": 1, "preced": 1, "test": [1, 3, 4, 5, 7, 8], "lint": [1, 3, 4], "help": [1, 5], "black": [1, 2, 7, 8], "isort": [1, 2], "mypi": [1, 2], "pyflak": 1, "local": [1, 2, 3, 4], "step": [1, 5], "necessari": 1, "review": 1, "default": [1, 5, 7, 9, 11], "header": [1, 8], "new": [1, 5, 8], "major": 1, "changelog": 1, "md": [1, 2], "root": [1, 5, 11], "updat": [1, 2, 5, 8], "here": [1, 3, 5], "readm": 1, "final": [1, 5], "merg": 1, "done": [1, 4, 5, 8], "our": [1, 2, 5], "guid": [1, 6], "question": [1, 3, 5], "hesit": 1, "open": [1, 2, 5, 6, 8], "complex": 2, "like": [2, 5, 6], "registri": [2, 3, 6, 7, 8, 9, 10], "entri": 2, "haven": 2, "read": [2, 5, 8, 11], "want": [2, 5], "sdk": [2, 3, 5, 6], "client": [2, 3, 4, 6, 7, 11], "ll": 2, "creat": [2, 3, 6, 8, 11], "environ": [2, 5, 8], "auth": [2, 5, 7, 10], "docker": [2, 3, 5, 8, 9, 11], "rm": [2, 5], "p": [2, 5, 11], "5000": [2, 5, 6], "ghcr": [2, 5, 6], "io": [2, 5, 6, 8, 11], "latest": [2, 5], "And": [2, 5, 6], "ultim": 2, "script": 2, "sh": 2, "ipython": [2, 4], "somewher": 2, "pip": [2, 4, 6], "emb": 2, "last": 2, "line": [2, 5, 8, 11], "pytest": 2, "x": 2, "abl": [2, 3, 5], "debug": [2, 3, 7, 8], "action": [2, 5], "pre": 2, "commit": 2, "handl": [2, 5, 8], "flake8": 2, "setup": [2, 5, 8], "end": 2, "ensur": [2, 5, 8, 11], "larg": 2, "tool": [2, 5], "easi": [2, 5], "after": 2, "py": [2, 4, 5, 8], "r": [2, 11], "dev": [2, 5, 11], "txt": [2, 5, 6], "Then": [2, 5], "manual": [2, 4, 9], "check": [2, 5, 9], "ad": 2, "pass": [2, 5], "case": 2, "conflict": 2, "trim": 2, "trail": 2, "whitespac": 2, "mix": 2, "hook": 2, "so": [2, 4, 5], "never": 2, "flaw": 2, "courtesi": [2, 5, 8], "command": [2, 5, 8], "via": [2, 4, 8], "doc": [2, 3, 5], "folder": [2, 5], "most": [2, 5], "getting_start": 2, "eas": 2, "e": [2, 4, 5, 11], "g": [2, 5, 11], "mostli": 2, "everyth": [2, 4], "modul": [2, 4, 7], "markdown": 2, "need": [2, 5], "toctre": 2, "extra": [2, 4, 11], "newlin": 2, "space": 2, "index": [2, 8], "chosen": 2, "why": 2, "chose": 2, "over": 2, "restructur": 2, "built": 2, "sphinx": 2, "now": [2, 5], "cd": [2, 4], "requr": 2, "_build": 2, "html": 2, "enter": 2, "start": [2, 5, 6], "web": [2, 5], "server": [2, 5], "m": 2, "9999": 2, "browser": 2, "localhost": [2, 5, 6, 11], "render": 2, "api": [2, 8], "keep": 2, "demand": 2, "apidoc": 2, "remov": [2, 5, 8], "function": [2, 5, 8, 10, 11], "oci": [3, 6, 7, 11], "storag": [3, 6, 8], "easili": [3, 5], "pull": [3, 6, 7, 8, 10], "push": [3, 6, 7, 8, 10], "artifact": [3, 5, 6, 8], "build": [3, 4], "custom": [3, 8, 9], "primari": 3, "found": [3, 5, 11], "let": [3, 5], "u": [3, 5], "know": [3, 5], "instal": [3, 6], "pypi": 3, "tag": [3, 8, 10], "authent": [3, 8, 10], "run": [3, 4, 5, 8, 9, 10], "depend": [3, 4], "preview": 3, "docstr": 3, "clone": 4, "git": 4, "com": 4, "sever": 4, "mode": [4, 8, 11], "instead": [4, 5, 8, 9], "Or": [4, 5, 11], "ve": [4, 5], "librari": [4, 6], "immedi": 4, "live": 4, "dockerfil": 4, "allow": [5, 8], "tradit": 5, "set": [5, 8], "As": 5, "longer": 5, "walk": 5, "variou": 5, "point": 5, "relev": 5, "implement": 5, "learn": 5, "about": 5, "access": 5, "decid": 5, "context": [5, 11], "singl": [5, 8], "move": 5, "subclass": 5, "manifest": [5, 8, 10, 11], "layer": [5, 7, 8], "It": [5, 11], "often": 5, "deploi": 5, "detach": 5, "brave": 5, "try": [5, 8], "basic": [5, 6, 8, 10], "htpassword": 5, "bcrypt": 5, "htpasswd": 5, "cb": 5, "myuser": [5, 6], "mypass": 5, "login": [5, 6, 7, 8, 10], "won": 5, "token": [5, 8], "v": 5, "pwd": 5, "etc": [5, 8], "registry_auth": 5, "realm": 5, "path": [5, 8, 9, 10, 11], "mimic": 5, "myprovid": 5, "logout": [5, 7, 8, 10], "wrap": 5, "orascli": [5, 6, 7, 8], "self": 5, "set_basic_auth": [5, 7, 8], "usernam": [5, 6, 8, 9], "password": [5, 6, 8, 9], "current": 5, "just": 5, "idea": 5, "request": [5, 6, 7, 8], "config": [5, 8, 9, 11], "helper": [5, 11], "click": 5, "expand": 5, "empti": [5, 8], "size": [5, 7, 8, 11], "null": [5, 11], "conf": 5, "config_fil": 5, "manifestconfig": [5, 7, 8], "mediatyp": [5, 7, 8], "vnd": [5, 11], "unknown": 5, "v1": [5, 6, 8, 11], "json": [5, 11], "digest": [5, 7, 8], "sha256": [5, 11], "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855": 5, "alreadi": [5, 11], "tmp": [5, 6], "3891": 5, "1192142acbf7ac7578906407f5a28820c4ff69937000558613c2d9ec56db370a": 5, "befor": 5, "them": [5, 11], "popul": 5, "sai": 5, "blob": [5, 8, 11], "o": 5, "newlay": [5, 7, 8], "is_dir": [5, 8], "fals": [5, 8, 11], "media_typ": [5, 8], "dinosaur": [5, 6], "blobish": 5, "rel": [5, 8], "download": [5, 8], "basenam": 5, "flat": 5, "directori": [5, 8, 10, 11], "doesn": 5, "annotation_titl": 5, "append": 5, "next": 5, "what": 5, "full": [5, 8], "some": 5, "around": 5, "fairli": 5, "straight": 5, "forward": 5, "newmanifest": [5, 7, 8], "too": 5, "food": 5, "avocado": [5, 6], "previous": 5, "given": [5, 8, 11], "would": [5, 6], "upload_manifest": [5, 7, 8], "packag": [5, 7], "complet": [5, 8], "uniqu": [5, 8], "resourc": [5, 8], "get_tag": [5, 7, 8], "instanti": 5, "ask": 5, "get": [5, 6, 8, 10, 11], "conda": 5, "forg": 5, "could": [5, 8], "hostnam": [5, 8], "insecur": [5, 8], "number": [5, 8], "mirror": 5, "linux": 5, "aarch64": 5, "arrow": 5, "cpp": 5, "n": [5, 8], "1005": 5, "spec": 5, "veri": 5, "present": 5, "true": [5, 8, 11], "target": [5, 6, 8, 10, 11], "successfulli": [5, 6, 8], "201": [5, 6], "similar": [5, 9], "better": 5, "overrid": 5, "maintain": 5, "lookup": [5, 8], "conform": [5, 6], "expect": [5, 11], "group": 5, "pakag": 5, "q6amnrkq": 5, "16": 5, "tar": [5, 11], "gz": [5, 11], "imag": [5, 11], "gzip": 5, "sbom": 5, "cyclonedx": 5, "sinc": 5, "dictionari": [5, 8, 11], "kei": [5, 8], "upload": [5, 8], "decor": [5, 7], "ensure_contain": [5, 7, 8], "sy": 5, "def": 5, "dict": [5, 8, 9, 11], "none": [5, 8, 9, 11], "correspond": [5, 8], "annotset": 5, "item": 5, "logger": [5, 7], "exit": [5, 7, 8], "f": 5, "save": [5, 8], "compress": [5, 11], "blob_nam": 5, "cleanup_blob": 5, "isdir": 5, "util": [5, 7, 8], "make_targz": [5, 8, 11], "get_annot": [5, 7, 8], "upload_blob": [5, 7, 8], "_check_200_respons": 5, "cleanup": [5, 7, 8], "temporari": [5, 11], "targz": [5, 11], "manifest_annot": [5, 8], "config_annot": 5, "anoth": 5, "return": [5, 8, 11], "argument": [5, 8], "pars": [5, 7, 8, 10, 11], "remaind": 5, "between": 5, "usag": 5, "specifi": 5, "intuit": 5, "show": [5, 8], "workdir": [5, 8, 11], "log": [5, 8], "getlogg": 5, "__name__": 5, "get_oras_cli": 5, "method": 5, "oras_us": 5, "oras_pass": 5, "reg": 5, "els": 5, "miss": 5, "metadata": 5, "datatyp": 5, "warn": [5, 7, 8], "continu": 5, "extract": [5, 11], "info": [5, 7, 8], "uri": [5, 7, 8], "assembl": [5, 8], "datetim": 5, "oras_cli": 5, "listdir": 5, "filenam": [5, 8, 11], "logic": [5, 8, 10], "getsiz": 5, "join": 5, "byte": 5, "creationtim": 5, "str": [5, 8, 9, 11], "cach": 5, "simpler": 5, "than": 5, "re": [5, 6], "e5itvzfi": [5, 6], "imagin": 5, "retriev": [5, 8], "oper": [5, 11], "inspect": 5, "get_contain": [5, 7, 8], "three": 5, "get_manifest": [5, 7, 8], "organ": 5, "_organize_lay": 5, "find": [5, 11], "correct": 5, "get_blob": [5, 7, 8], "download_blob": [5, 7, 8], "stream": [5, 8], "extend": 5, "shown": 5, "abil": 5, "multipl": [5, 8], "select": 5, "download_lay": 5, "download_dir": 5, "desir": [5, 8], "intend": [5, 8], "call": [5, 8], "again": 5, "interest": 5, "presenc": 5, "string": [5, 8, 11], "price": 5, "come": 5, "googl": 5, "aw": 5, "practic": 5, "opencontain": 5, "rais": [5, 11], "error": [5, 7, 8, 11], "malici": 5, "outfil": 5, "sanitize_path": [5, 8, 11], "output": [5, 8, 11], "creativ": 5, "perhap": 5, "memori": 5, "further": 5, "11": 5, "expos": 5, "earlier": 5, "_download_blob": 5, "credenti": [5, 8, 10], "person": 5, "github_token": 5, "github_us": 5, "wolfv": 5, "64": 5, "xtensor": 5, "vsoch": 5, "excel": 5, "supplement": 5, "offici": 5, "ye": 5, "setup_logg": [5, 7, 8], "quiet": [5, 8], "my": 5, "messag": [5, 8], "verbos": 5, "unauthor": 5, "amazon": 5, "ecr": 5, "per": 5, "instruct": 5, "credsstor": 5, "extern": 5, "store": 5, "saniti": 5, "correctli": 5, "base64": 5, "encod": [5, 8], "actual": 5, "cool": 5, "think": 5, "happi": 5, "benefit": 5, "starter": 5, "task": 5, "welcom": 6, "enabl": [6, 11], "featur": 6, "process": 6, "apach": 6, "licens": 6, "subpackag": 7, "submodul": 7, "test_ora": [7, 8], "test_provid": [7, 8], "test_util": [7, 8], "fileio": [7, 8], "authhead": [7, 8], "get_basic_auth": [7, 8], "load_config": [7, 8], "parse_auth_head": [7, 8], "delete_tag": [7, 8], "set_token_auth": [7, 8], "api_prefix": [7, 8], "get_blob_url": [7, 8], "manifest_url": [7, 8], "tags_url": [7, 8], "upload_blob_url": [7, 8], "classretri": [7, 8], "retri": [7, 8], "default_v2_registri": [7, 8], "index_hostnam": [7, 8], "index_nam": [7, 8], "index_serv": [7, 8], "colorizingstreamhandl": [7, 8], "blue": [7, 8], "bold_seq": [7, 8], "color_seq": [7, 8], "cyan": [7, 8], "green": [7, 8], "magenta": [7, 8], "red": [7, 8], "reset_seq": [7, 8], "white": [7, 8], "yellow": [7, 8], "can_color_tti": [7, 8], "color": [7, 8], "emit": [7, 8], "is_tti": [7, 8], "handler": [7, 8], "locat": [7, 8], "progress": [7, 8], "set_level": [7, 8], "set_stream_handl": [7, 8], "shellcmd": [7, 8], "text_handl": [7, 8], "load": [7, 8, 9], "set_media_typ": [7, 8], "to_dict": [7, 8], "authenticate_request": [7, 8], "chunked_upload": [7, 8], "do_request": [7, 8], "put_upload": [7, 8], "request_anonymous_token": [7, 8], "reset_basic_auth": [7, 8], "set_head": [7, 8], "temporary_empty_config": [7, 8], "schema": 7, "dockercli": [8, 9], "test_basic_ora": [8, 10], "test_basic_push_pul": [8, 10], "test_directory_push_pul": [8, 10], "test_get_delete_tag": [8, 10], "test_get_many_tag": [8, 10], "test_login_logout": [8, 10], "test_annotated_registry_push": [8, 10], "test_parse_manifest": [8, 10], "test_sanitize_path": [8, 10], "test_copyfil": [8, 10], "test_get_tmpdir_tmpfil": [8, 10], "test_mkdir_p": [8, 10], "test_print_json": [8, 10], "test_split_path_and_cont": [8, 10], "test_workdir": [8, 10], "test_write_bad_json": [8, 10], "test_write_json": [8, 10], "test_write_read_fil": [8, 10], "pathandoptionalcont": [8, 11], "copyfil": [8, 11], "extract_targz": [8, 11], "get_file_hash": [8, 11], "get_siz": [8, 11], "get_tmpdir": [8, 11], "get_tmpfil": [8, 11], "is_within_directori": [8, 11], "mkdir_p": [8, 11], "print_json": [8, 11], "read_fil": [8, 11], "read_in_chunk": [8, 11], "read_json": [8, 11], "readlin": [8, 11], "recursive_find": [8, 11], "split_path_and_cont": [8, 11], "write_fil": [8, 11], "write_json": [8, 11], "append_url_param": [8, 11], "find_docker_config": [8, 11], "get_docker_cli": [8, 11], "iter_localhost": [8, 11], "paramet": [8, 9, 11], "account": [8, 9], "filesystem": 8, "option": [8, 11], "authheaderraw": 8, "piec": 8, "bool": [8, 11], "tls_verifi": [8, 11], "wrapper": 8, "isol": 8, "intern": 8, "standard": 8, "delet": [8, 10], "int": [8, 11], "password_stdin": 8, "config_path": 8, "input": 8, "verifi": 8, "tl": [8, 11], "arg": 8, "kwarg": [8, 11], "remot": 8, "bearer": 8, "return_item": 8, "param": [8, 11], "properti": 8, "prefix": [8, 11], "v2": 8, "endpoint": 8, "url": [8, 11], "compon": 8, "func": 8, "parent": [8, 11], "attempt": 8, "timeout": 8, "host": [8, 11], "scheme": 8, "nocolor": 8, "pathlib": 8, "textio": [8, 11], "_io": 8, "textiowrapp": 8, "stderr": 8, "w": [8, 11], "utf": 8, "use_thread": 8, "streamhandl": 8, "x1b": 8, "1m": 8, "dm": 8, "0m": 8, "tty": 8, "critic": 8, "record": 8, "logrecord": 8, "close": 8, "msg": 8, "level": 8, "return_cod": 8, "total": 8, "bar": 8, "count": 8, "stream_handl": 8, "consol": 8, "printshellcmd": 8, "stdout": 8, "init": 8, "shell": 8, "thread": 8, "valu": 8, "pair": 8, "blob_path": 8, "vari": 8, "represent": 8, "tupl": [8, 11], "isn": [8, 10], "originalrespons": 8, "chunk": [8, 11], "allowed_media_typ": 8, "overwrit": 8, "refresh_head": 8, "refresh": 8, "fetch": 8, "manifest_config_ref": 8, "outdir": [8, 11], "disable_path_valid": 8, "annotation_fil": 8, "refer": [8, 11], "put": 8, "h": 8, "fall": 8, "back": 8, "anonym": 8, "boolean": 8, "reset": 8, "do_chunk": 8, "1024": [8, 11], "approach": 8, "post": 8, "patch": 8, "insid": 9, "dockercfg_path": 9, "dockercfg_str": 9, "tmp_path": 10, "target_dir": 10, "creationg": 10, "mani": 10, "window": 10, "thei": 10, "usual": 10, "split": 10, "destin": 11, "forc": 11, "numeric_own": 11, "algorithm": 11, "hash": 11, "attributeerror": 11, "incorrect": 11, "suppli": 11, "tmpdir": 11, "suffix": 11, "extens": 11, "source_dir": 11, "dest_nam": 11, "akin": 11, "mkdir": 11, "json_obj": 11, "pretti": 11, "bufferedread": 11, "chunk_siz": 11, "1k": 11, "descriptor": 11, "stdin": 11, "pattern": 11, "match": 11, "yield": 11, "search": 11, "fnmatch": 11, "expected_dir": 11, "resolv": 11, "directli": 11, "child": 11, "outsid": 11, "happen": 11, "myconfig": 11, "dirnam": 11, "stuff": 11, "make_exec": 11, "filnam": 11, "alwai": 11, "127": 11}, "objects": {"": [[8, 0, 0, "-", "oras"]], "oras": [[8, 0, 0, "-", "auth"], [8, 0, 0, "-", "client"], [8, 0, 0, "-", "container"], [8, 0, 0, "-", "decorator"], [8, 0, 0, "-", "defaults"], [8, 0, 0, "-", "logger"], [9, 0, 0, "-", "main"], [8, 0, 0, "-", "oci"], [8, 0, 0, "-", "provider"], [8, 0, 0, "-", "schemas"], [10, 0, 0, "-", "tests"], [11, 0, 0, "-", "utils"], [8, 0, 0, "-", "version"]], "oras.auth": [[8, 1, 1, "", "authHeader"], [8, 2, 1, "", "get_basic_auth"], [8, 2, 1, "", "load_configs"], [8, 2, 1, "", "parse_auth_header"]], "oras.client": [[8, 1, 1, "", "OrasClient"]], "oras.client.OrasClient": [[8, 3, 1, "", "delete_tags"], [8, 3, 1, "", "get_tags"], [8, 3, 1, "", "login"], [8, 3, 1, "", "logout"], [8, 3, 1, "", "pull"], [8, 3, 1, "", "push"], [8, 3, 1, "", "set_basic_auth"], [8, 3, 1, "", "set_token_auth"], [8, 3, 1, "", "version"]], "oras.container": [[8, 1, 1, "", "Container"]], "oras.container.Container": [[8, 4, 1, "", "api_prefix"], [8, 3, 1, "", "get_blob_url"], [8, 3, 1, "", "manifest_url"], [8, 3, 1, "", "parse"], [8, 3, 1, "", "tags_url"], [8, 3, 1, "", "upload_blob_url"], [8, 4, 1, "", "uri"]], "oras.decorator": [[8, 1, 1, "", "Decorator"], [8, 1, 1, "", "classretry"], [8, 1, 1, "", "ensure_container"], [8, 2, 1, "", "retry"]], "oras.defaults": [[8, 1, 1, "", "registry"]], "oras.defaults.registry": [[8, 5, 1, "", "default_v2_registry"], [8, 5, 1, "", "index_hostname"], [8, 5, 1, "", "index_name"], [8, 5, 1, "", "index_server"]], "oras.logger": [[8, 1, 1, "", "ColorizingStreamHandler"], [8, 1, 1, "", "Logger"], [8, 2, 1, "", "setup_logger"]], "oras.logger.ColorizingStreamHandler": [[8, 5, 1, "", "BLACK"], [8, 5, 1, "", "BLUE"], [8, 5, 1, "", "BOLD_SEQ"], [8, 5, 1, "", "COLOR_SEQ"], [8, 5, 1, "", "CYAN"], [8, 5, 1, "", "GREEN"], [8, 5, 1, "", "MAGENTA"], [8, 5, 1, "", "RED"], [8, 5, 1, "", "RESET_SEQ"], [8, 5, 1, "", "WHITE"], [8, 5, 1, "", "YELLOW"], [8, 3, 1, "", "can_color_tty"], [8, 5, 1, "", "colors"], [8, 3, 1, "", "decorate"], [8, 3, 1, "", "emit"], [8, 4, 1, "", "is_tty"]], "oras.logger.Logger": [[8, 3, 1, "", "cleanup"], [8, 3, 1, "", "debug"], [8, 3, 1, "", "error"], [8, 3, 1, "", "exit"], [8, 3, 1, "", "handler"], [8, 3, 1, "", "info"], [8, 3, 1, "", "location"], [8, 3, 1, "", "progress"], [8, 3, 1, "", "set_level"], [8, 3, 1, "", "set_stream_handler"], [8, 3, 1, "", "shellcmd"], [8, 3, 1, "", "text_handler"], [8, 3, 1, "", "warning"]], "oras.main": [[9, 0, 0, "-", "login"]], "oras.main.login": [[9, 1, 1, "", "DockerClient"]], "oras.main.login.DockerClient": [[9, 3, 1, "", "login"]], "oras.oci": [[8, 1, 1, "", "Annotations"], [8, 1, 1, "", "Layer"], [8, 2, 1, "", "ManifestConfig"], [8, 2, 1, "", "NewLayer"], [8, 2, 1, "", "NewManifest"]], "oras.oci.Annotations": [[8, 3, 1, "", "add"], [8, 3, 1, "", "get_annotations"], [8, 3, 1, "", "load"]], "oras.oci.Layer": [[8, 3, 1, "", "set_media_type"], [8, 3, 1, "", "to_dict"]], "oras.provider": [[8, 1, 1, "", "Registry"], [8, 1, 1, "", "Subject"], [8, 2, 1, "", "temporary_empty_config"]], "oras.provider.Registry": [[8, 3, 1, "", "authenticate_request"], [8, 3, 1, "", "chunked_upload"], [8, 3, 1, "", "delete_tag"], [8, 3, 1, "", "do_request"], [8, 3, 1, "", "download_blob"], [8, 3, 1, "", "get_blob"], [8, 3, 1, "", "get_container"], [8, 3, 1, "", "get_manifest"], [8, 3, 1, "", "get_tags"], [8, 3, 1, "", "load_configs"], [8, 3, 1, "", "logout"], [8, 3, 1, "", "pull"], [8, 3, 1, "", "push"], [8, 3, 1, "", "put_upload"], [8, 3, 1, "", "request_anonymous_token"], [8, 3, 1, "", "reset_basic_auth"], [8, 3, 1, "", "set_basic_auth"], [8, 3, 1, "", "set_header"], [8, 3, 1, "", "set_token_auth"], [8, 3, 1, "", "upload_blob"], [8, 3, 1, "", "upload_manifest"]], "oras.provider.Subject": [[8, 5, 1, "", "digest"], [8, 5, 1, "", "mediaType"], [8, 5, 1, "", "size"]], "oras.tests": [[10, 0, 0, "-", "test_oras"], [10, 0, 0, "-", "test_provider"], [10, 0, 0, "-", "test_utils"]], "oras.tests.test_oras": [[10, 2, 1, "", "test_basic_oras"], [10, 2, 1, "", "test_basic_push_pull"], [10, 2, 1, "", "test_directory_push_pull"], [10, 2, 1, "", "test_get_delete_tags"], [10, 2, 1, "", "test_get_many_tags"], [10, 2, 1, "", "test_login_logout"]], "oras.tests.test_provider": [[10, 2, 1, "", "test_annotated_registry_push"], [10, 2, 1, "", "test_parse_manifest"], [10, 2, 1, "", "test_sanitize_path"]], "oras.tests.test_utils": [[10, 2, 1, "", "test_copyfile"], [10, 2, 1, "", "test_get_tmpdir_tmpfile"], [10, 2, 1, "", "test_mkdir_p"], [10, 2, 1, "", "test_print_json"], [10, 2, 1, "", "test_split_path_and_content"], [10, 2, 1, "", "test_workdir"], [10, 2, 1, "", "test_write_bad_json"], [10, 2, 1, "", "test_write_json"], [10, 2, 1, "", "test_write_read_files"]], "oras.utils": [[11, 0, 0, "-", "fileio"], [11, 0, 0, "-", "request"]], "oras.utils.fileio": [[11, 1, 1, "", "PathAndOptionalContent"], [11, 2, 1, "", "copyfile"], [11, 2, 1, "", "extract_targz"], [11, 2, 1, "", "get_file_hash"], [11, 2, 1, "", "get_size"], [11, 2, 1, "", "get_tmpdir"], [11, 2, 1, "", "get_tmpfile"], [11, 2, 1, "", "is_within_directory"], [11, 2, 1, "", "make_targz"], [11, 2, 1, "", "mkdir_p"], [11, 2, 1, "", "print_json"], [11, 2, 1, "", "read_file"], [11, 2, 1, "", "read_in_chunks"], [11, 2, 1, "", "read_json"], [11, 2, 1, "", "readline"], [11, 2, 1, "", "recursive_find"], [11, 2, 1, "", "sanitize_path"], [11, 2, 1, "", "split_path_and_content"], [11, 2, 1, "", "workdir"], [11, 2, 1, "", "write_file"], [11, 2, 1, "", "write_json"]], "oras.utils.request": [[11, 2, 1, "", "append_url_params"], [11, 2, 1, "", "find_docker_config"], [11, 2, 1, "", "get_docker_client"], [11, 2, 1, "", "iter_localhosts"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:function", "3": "py:method", "4": "py:property", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "function", "Python function"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"apach": 0, "licens": 0, "contribut": 1, "pull": [1, 5], "request": [1, 11], "process": 1, "develop": [2, 5], "guid": [2, 3, 5], "run": 2, "test": [2, 10], "code": 2, "lint": 2, "document": 2, "instal": [2, 4], "depend": 2, "build": 2, "preview": 2, "docstr": 2, "pypi": 4, "docker": 4, "contain": [4, 8], "user": 5, "local": 5, "registri": 5, "creat": 5, "client": [5, 8], "class": 5, "oci": [5, 8], "object": 5, "tag": 5, "push": 5, "interact": 5, "authent": 5, "debug": 5, "custom": 5, "ora": [6, 7, 8, 9, 10, 11], "python": 6, "api": 6, "packag": [8, 9, 10, 11], "subpackag": 8, "submodul": [8, 9, 10, 11], "auth": 8, "modul": [8, 9, 10, 11], "decor": 8, "default": 8, "logger": 8, "provid": 8, "schema": 8, "version": 8, "content": [8, 9, 10, 11], "main": 9, "login": 9, "test_ora": 10, "test_provid": 10, "test_util": 10, "util": 11, "fileio": 11, "exampl": 11}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "nbsphinx": 4, "sphinx": 60}, "alltitles": {"Developer Guide": [[2, "developer-guide"]], "Running Tests": [[2, "running-tests"]], "Code Linting": [[2, "code-linting"]], "Documentation": [[2, "documentation"]], "Install Dependencies and Build": [[2, "install-dependencies-and-build"]], "Preview Documentation": [[2, "preview-documentation"]], "Docstrings": [[2, "docstrings"]], "Contributing": [[1, "contributing"]], "Pull Request Process": [[1, "pull-request-process"]], "Apache License": [[0, "apache-license"]], "Guides": [[3, "guides"]], "User Guide": [[5, "user-guide"]], "Local Development Registry": [[5, "local-development-registry"]], "Create a Client Class": [[5, "create-a-client-class"]], "Creating OCI Objects": [[5, "creating-oci-objects"]], "Tags": [[5, "tags"]], "Push Interactions": [[5, "push-interactions"]], "Pull Interactions": [[5, "pull-interactions"]], "Authentication": [[5, "authentication"]], "Debugging": [[5, "debugging"]], "Custom Clients": [[5, "custom-clients"]], "Installation": [[4, "installation"]], "Pypi": [[4, "pypi"]], "Docker Container": [[4, "docker-container"]], "oras.tests package": [[10, "oras-tests-package"]], "Submodules": [[10, "submodules"], [9, "submodules"], [11, "submodules"], [8, "submodules"]], "oras.tests.test_oras module": [[10, "module-oras.tests.test_oras"]], "oras.tests.test_provider module": [[10, "module-oras.tests.test_provider"]], "oras.tests.test_utils module": [[10, "module-oras.tests.test_utils"]], "Module contents": [[10, "module-oras.tests"], [9, "module-oras.main"], [11, "module-oras.utils"], [8, "module-oras"]], "oras.main package": [[9, "oras-main-package"]], "oras.main.login module": [[9, "module-oras.main.login"]], "oras.utils package": [[11, "oras-utils-package"]], "oras.utils.fileio module": [[11, "module-oras.utils.fileio"]], "Examples": [[11, "examples"]], "oras.utils.request module": [[11, "module-oras.utils.request"]], "oras package": [[8, "oras-package"]], "Subpackages": [[8, "subpackages"]], "oras.auth module": [[8, "module-oras.auth"]], "oras.client module": [[8, "module-oras.client"]], "oras.container module": [[8, "module-oras.container"]], "oras.decorator module": [[8, "module-oras.decorator"]], "oras.defaults module": [[8, "module-oras.defaults"]], "oras.logger module": [[8, "module-oras.logger"]], "oras.oci module": [[8, "module-oras.oci"]], "oras.provider module": [[8, "module-oras.provider"]], "oras.schemas module": [[8, "module-oras.schemas"]], "oras.version module": [[8, "module-oras.version"]], "oras": [[7, "oras"]], "Oras Python": [[6, "oras-python"]], "API": [[6, null]]}, "indexentries": {"annotations (class in oras.oci)": [[8, "oras.oci.Annotations"]], "black (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BLACK"]], "blue (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BLUE"]], "bold_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.BOLD_SEQ"]], "color_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.COLOR_SEQ"]], "cyan (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.CYAN"]], "colorizingstreamhandler (class in oras.logger)": [[8, "oras.logger.ColorizingStreamHandler"]], "container (class in oras.container)": [[8, "oras.container.Container"]], "decorator (class in oras.decorator)": [[8, "oras.decorator.Decorator"]], "green (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.GREEN"]], "layer (class in oras.oci)": [[8, "oras.oci.Layer"]], "logger (class in oras.logger)": [[8, "oras.logger.Logger"]], "magenta (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.MAGENTA"]], "manifestconfig() (in module oras.oci)": [[8, "oras.oci.ManifestConfig"]], "newlayer() (in module oras.oci)": [[8, "oras.oci.NewLayer"]], "newmanifest() (in module oras.oci)": [[8, "oras.oci.NewManifest"]], "orasclient (class in oras.client)": [[8, "oras.client.OrasClient"]], "red (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.RED"]], "reset_seq (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.RESET_SEQ"]], "registry (class in oras.provider)": [[8, "oras.provider.Registry"]], "subject (class in oras.provider)": [[8, "oras.provider.Subject"]], "white (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.WHITE"]], "yellow (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.YELLOW"]], "add() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.add"]], "api_prefix (oras.container.container property)": [[8, "oras.container.Container.api_prefix"]], "authheader (class in oras.auth)": [[8, "oras.auth.authHeader"]], "authenticate_request() (oras.provider.registry method)": [[8, "oras.provider.Registry.authenticate_request"]], "can_color_tty() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.can_color_tty"]], "chunked_upload() (oras.provider.registry method)": [[8, "oras.provider.Registry.chunked_upload"]], "classretry (class in oras.decorator)": [[8, "oras.decorator.classretry"]], "cleanup() (oras.logger.logger method)": [[8, "oras.logger.Logger.cleanup"]], "colors (oras.logger.colorizingstreamhandler attribute)": [[8, "oras.logger.ColorizingStreamHandler.colors"]], "debug() (oras.logger.logger method)": [[8, "oras.logger.Logger.debug"]], "decorate() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.decorate"]], "default_v2_registry (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.default_v2_registry"]], "delete_tag() (oras.provider.registry method)": [[8, "oras.provider.Registry.delete_tag"]], "delete_tags() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.delete_tags"]], "digest (oras.provider.subject attribute)": [[8, "oras.provider.Subject.digest"]], "do_request() (oras.provider.registry method)": [[8, "oras.provider.Registry.do_request"]], "download_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.download_blob"]], "emit() (oras.logger.colorizingstreamhandler method)": [[8, "oras.logger.ColorizingStreamHandler.emit"]], "ensure_container (class in oras.decorator)": [[8, "oras.decorator.ensure_container"]], "error() (oras.logger.logger method)": [[8, "oras.logger.Logger.error"]], "exit() (oras.logger.logger method)": [[8, "oras.logger.Logger.exit"]], "get_annotations() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.get_annotations"]], "get_basic_auth() (in module oras.auth)": [[8, "oras.auth.get_basic_auth"]], "get_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_blob"]], "get_blob_url() (oras.container.container method)": [[8, "oras.container.Container.get_blob_url"]], "get_container() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_container"]], "get_manifest() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_manifest"]], "get_tags() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.get_tags"]], "get_tags() (oras.provider.registry method)": [[8, "oras.provider.Registry.get_tags"]], "handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.handler"]], "index_hostname (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_hostname"]], "index_name (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_name"]], "index_server (oras.defaults.registry attribute)": [[8, "oras.defaults.registry.index_server"]], "info() (oras.logger.logger method)": [[8, "oras.logger.Logger.info"]], "is_tty (oras.logger.colorizingstreamhandler property)": [[8, "oras.logger.ColorizingStreamHandler.is_tty"]], "load() (oras.oci.annotations method)": [[8, "oras.oci.Annotations.load"]], "load_configs() (in module oras.auth)": [[8, "oras.auth.load_configs"]], "load_configs() (oras.provider.registry method)": [[8, "oras.provider.Registry.load_configs"]], "location() (oras.logger.logger method)": [[8, "oras.logger.Logger.location"]], "login() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.login"]], "logout() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.logout"]], "logout() (oras.provider.registry method)": [[8, "oras.provider.Registry.logout"]], "manifest_url() (oras.container.container method)": [[8, "oras.container.Container.manifest_url"]], "mediatype (oras.provider.subject attribute)": [[8, "oras.provider.Subject.mediaType"]], "module": [[8, "module-oras"], [8, "module-oras.auth"], [8, "module-oras.client"], [8, "module-oras.container"], [8, "module-oras.decorator"], [8, "module-oras.defaults"], [8, "module-oras.logger"], [8, "module-oras.oci"], [8, "module-oras.provider"], [8, "module-oras.schemas"], [8, "module-oras.version"], [9, "module-oras.main"], [9, "module-oras.main.login"], [10, "module-oras.tests"], [10, "module-oras.tests.test_oras"], [10, "module-oras.tests.test_provider"], [10, "module-oras.tests.test_utils"], [11, "module-oras.utils"], [11, "module-oras.utils.fileio"], [11, "module-oras.utils.request"]], "oras": [[8, "module-oras"]], "oras.auth": [[8, "module-oras.auth"]], "oras.client": [[8, "module-oras.client"]], "oras.container": [[8, "module-oras.container"]], "oras.decorator": [[8, "module-oras.decorator"]], "oras.defaults": [[8, "module-oras.defaults"]], "oras.logger": [[8, "module-oras.logger"]], "oras.oci": [[8, "module-oras.oci"]], "oras.provider": [[8, "module-oras.provider"]], "oras.schemas": [[8, "module-oras.schemas"]], "oras.version": [[8, "module-oras.version"]], "parse() (oras.container.container method)": [[8, "oras.container.Container.parse"]], "parse_auth_header() (in module oras.auth)": [[8, "oras.auth.parse_auth_header"]], "progress() (oras.logger.logger method)": [[8, "oras.logger.Logger.progress"]], "pull() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.pull"]], "pull() (oras.provider.registry method)": [[8, "oras.provider.Registry.pull"]], "push() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.push"]], "push() (oras.provider.registry method)": [[8, "oras.provider.Registry.push"]], "put_upload() (oras.provider.registry method)": [[8, "oras.provider.Registry.put_upload"]], "registry (class in oras.defaults)": [[8, "oras.defaults.registry"]], "request_anonymous_token() (oras.provider.registry method)": [[8, "oras.provider.Registry.request_anonymous_token"]], "reset_basic_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.reset_basic_auth"]], "retry() (in module oras.decorator)": [[8, "oras.decorator.retry"]], "set_basic_auth() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.set_basic_auth"]], "set_basic_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_basic_auth"]], "set_header() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_header"]], "set_level() (oras.logger.logger method)": [[8, "oras.logger.Logger.set_level"]], "set_media_type() (oras.oci.layer method)": [[8, "oras.oci.Layer.set_media_type"]], "set_stream_handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.set_stream_handler"]], "set_token_auth() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.set_token_auth"]], "set_token_auth() (oras.provider.registry method)": [[8, "oras.provider.Registry.set_token_auth"]], "setup_logger() (in module oras.logger)": [[8, "oras.logger.setup_logger"]], "shellcmd() (oras.logger.logger method)": [[8, "oras.logger.Logger.shellcmd"]], "size (oras.provider.subject attribute)": [[8, "oras.provider.Subject.size"]], "tags_url() (oras.container.container method)": [[8, "oras.container.Container.tags_url"]], "temporary_empty_config() (in module oras.provider)": [[8, "oras.provider.temporary_empty_config"]], "text_handler() (oras.logger.logger method)": [[8, "oras.logger.Logger.text_handler"]], "to_dict() (oras.oci.layer method)": [[8, "oras.oci.Layer.to_dict"]], "upload_blob() (oras.provider.registry method)": [[8, "oras.provider.Registry.upload_blob"]], "upload_blob_url() (oras.container.container method)": [[8, "oras.container.Container.upload_blob_url"]], "upload_manifest() (oras.provider.registry method)": [[8, "oras.provider.Registry.upload_manifest"]], "uri (oras.container.container property)": [[8, "oras.container.Container.uri"]], "version() (oras.client.orasclient method)": [[8, "oras.client.OrasClient.version"]], "warning() (oras.logger.logger method)": [[8, "oras.logger.Logger.warning"]], "dockerclient (class in oras.main.login)": [[9, "oras.main.login.DockerClient"]], "login() (oras.main.login.dockerclient method)": [[9, "oras.main.login.DockerClient.login"]], "oras.main": [[9, "module-oras.main"]], "oras.main.login": [[9, "module-oras.main.login"]], "oras.tests": [[10, "module-oras.tests"]], "oras.tests.test_oras": [[10, "module-oras.tests.test_oras"]], "oras.tests.test_provider": [[10, "module-oras.tests.test_provider"]], "oras.tests.test_utils": [[10, "module-oras.tests.test_utils"]], "test_annotated_registry_push() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_annotated_registry_push"]], "test_basic_oras() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_basic_oras"]], "test_basic_push_pull() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_basic_push_pull"]], "test_copyfile() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_copyfile"]], "test_directory_push_pull() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_directory_push_pull"]], "test_get_delete_tags() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_get_delete_tags"]], "test_get_many_tags() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_get_many_tags"]], "test_get_tmpdir_tmpfile() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_get_tmpdir_tmpfile"]], "test_login_logout() (in module oras.tests.test_oras)": [[10, "oras.tests.test_oras.test_login_logout"]], "test_mkdir_p() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_mkdir_p"]], "test_parse_manifest() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_parse_manifest"]], "test_print_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_print_json"]], "test_sanitize_path() (in module oras.tests.test_provider)": [[10, "oras.tests.test_provider.test_sanitize_path"]], "test_split_path_and_content() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_split_path_and_content"]], "test_workdir() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_workdir"]], "test_write_bad_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_bad_json"]], "test_write_json() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_json"]], "test_write_read_files() (in module oras.tests.test_utils)": [[10, "oras.tests.test_utils.test_write_read_files"]], "pathandoptionalcontent (class in oras.utils.fileio)": [[11, "oras.utils.fileio.PathAndOptionalContent"]], "append_url_params() (in module oras.utils.request)": [[11, "oras.utils.request.append_url_params"]], "copyfile() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.copyfile"]], "extract_targz() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.extract_targz"]], "find_docker_config() (in module oras.utils.request)": [[11, "oras.utils.request.find_docker_config"]], "get_docker_client() (in module oras.utils.request)": [[11, "oras.utils.request.get_docker_client"]], "get_file_hash() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_file_hash"]], "get_size() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_size"]], "get_tmpdir() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_tmpdir"]], "get_tmpfile() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.get_tmpfile"]], "is_within_directory() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.is_within_directory"]], "iter_localhosts() (in module oras.utils.request)": [[11, "oras.utils.request.iter_localhosts"]], "make_targz() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.make_targz"]], "mkdir_p() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.mkdir_p"]], "oras.utils": [[11, "module-oras.utils"]], "oras.utils.fileio": [[11, "module-oras.utils.fileio"]], "oras.utils.request": [[11, "module-oras.utils.request"]], "print_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.print_json"]], "read_file() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_file"]], "read_in_chunks() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_in_chunks"]], "read_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.read_json"]], "readline() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.readline"]], "recursive_find() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.recursive_find"]], "sanitize_path() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.sanitize_path"]], "split_path_and_content() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.split_path_and_content"]], "workdir() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.workdir"]], "write_file() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.write_file"]], "write_json() (in module oras.utils.fileio)": [[11, "oras.utils.fileio.write_json"]]}}) \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 4eb6fce..00b9ded 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -http://oras-project.github.io/oras-py/about/license.htmlhttp://oras-project.github.io/oras-py/contributing.htmlhttp://oras-project.github.io/oras-py/getting_started/developer-guide.htmlhttp://oras-project.github.io/oras-py/getting_started/index.htmlhttp://oras-project.github.io/oras-py/getting_started/installation.htmlhttp://oras-project.github.io/oras-py/getting_started/user-guide.htmlhttp://oras-project.github.io/oras-py/source/modules.htmlhttp://oras-project.github.io/oras-py/source/oras.htmlhttp://oras-project.github.io/oras-py/source/oras.tests.htmlhttp://oras-project.github.io/oras-py/index.htmlhttp://oras-project.github.io/oras-py/source/oras.utils.htmlhttp://oras-project.github.io/oras-py/source/oras.main.htmlhttp://oras-project.github.io/oras-py/genindex.htmlhttp://oras-project.github.io/oras-py/py-modindex.htmlhttp://oras-project.github.io/oras-py/_modules/functools.htmlhttp://oras-project.github.io/oras-py/_modules/oras/auth.htmlhttp://oras-project.github.io/oras-py/_modules/oras/client.htmlhttp://oras-project.github.io/oras-py/_modules/oras/container.htmlhttp://oras-project.github.io/oras-py/_modules/oras/decorator.htmlhttp://oras-project.github.io/oras-py/_modules/oras/defaults.htmlhttp://oras-project.github.io/oras-py/_modules/oras/logger.htmlhttp://oras-project.github.io/oras-py/_modules/oras/main/login.htmlhttp://oras-project.github.io/oras-py/_modules/oras/oci.htmlhttp://oras-project.github.io/oras-py/_modules/oras/provider.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_oras.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_provider.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_utils.htmlhttp://oras-project.github.io/oras-py/_modules/oras/utils/fileio.htmlhttp://oras-project.github.io/oras-py/_modules/oras/utils/request.htmlhttp://oras-project.github.io/oras-py/_modules/index.htmlhttp://oras-project.github.io/oras-py/search.html \ No newline at end of file +http://oras-project.github.io/oras-py/about/license.htmlhttp://oras-project.github.io/oras-py/contributing.htmlhttp://oras-project.github.io/oras-py/getting_started/developer-guide.htmlhttp://oras-project.github.io/oras-py/getting_started/index.htmlhttp://oras-project.github.io/oras-py/getting_started/installation.htmlhttp://oras-project.github.io/oras-py/getting_started/user-guide.htmlhttp://oras-project.github.io/oras-py/source/modules.htmlhttp://oras-project.github.io/oras-py/index.htmlhttp://oras-project.github.io/oras-py/source/oras.tests.htmlhttp://oras-project.github.io/oras-py/source/oras.htmlhttp://oras-project.github.io/oras-py/source/oras.utils.htmlhttp://oras-project.github.io/oras-py/source/oras.main.htmlhttp://oras-project.github.io/oras-py/genindex.htmlhttp://oras-project.github.io/oras-py/py-modindex.htmlhttp://oras-project.github.io/oras-py/_modules/functools.htmlhttp://oras-project.github.io/oras-py/_modules/oras/auth.htmlhttp://oras-project.github.io/oras-py/_modules/oras/client.htmlhttp://oras-project.github.io/oras-py/_modules/oras/container.htmlhttp://oras-project.github.io/oras-py/_modules/oras/decorator.htmlhttp://oras-project.github.io/oras-py/_modules/oras/defaults.htmlhttp://oras-project.github.io/oras-py/_modules/oras/logger.htmlhttp://oras-project.github.io/oras-py/_modules/oras/main/login.htmlhttp://oras-project.github.io/oras-py/_modules/oras/oci.htmlhttp://oras-project.github.io/oras-py/_modules/oras/provider.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_oras.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_provider.htmlhttp://oras-project.github.io/oras-py/_modules/oras/tests/test_utils.htmlhttp://oras-project.github.io/oras-py/_modules/oras/utils/fileio.htmlhttp://oras-project.github.io/oras-py/_modules/oras/utils/request.htmlhttp://oras-project.github.io/oras-py/_modules/index.htmlhttp://oras-project.github.io/oras-py/search.html \ No newline at end of file