PacletObject

PacletObject[assoc]

represents a paclet on the local machine or on a remote paclet site.

PacletObject["name"]

represents an installed paclet with the given name.

PacletObject["name""version"]

represents an installed paclet with the given name and version.

PacletObject[File[…]]

represents a paclet in a given directory or paclet archive file.

Details

  • PacletObject contains an association of metadata about the paclet.
  • PacletObject expressions are typically obtained from paclet functions like PacletInstall, PacletFind and PacletFindRemote.
  • PacletObject["name"] is essentially equivalent to First[PacletFind["name"]].
  • Possible metadata keys in assoc include:
  • "Name"name of the paclet; required
    "Version"version as a string; required
    "WolframVersion"what version(s) of the Wolfram Language the paclet is compatible with
    "SystemID"what $SystemID values the paclet is compatible with
    "ProductID"the name of the product the paclet is restricted to (e.g. "Mathematica")
    "Root"the location of the contents relative to the PacletInfo.wl file
    "Loading"when the paclet's .wl files load
    "AutoUpdating"whether the paclet automatically updates itself
    "Description"short description of the paclet
    "Category"a category or list of categories describing the functionality
    "Keywords"keywords relevant to the functionality
    "Creator"author or company information
    "Publisher"publisher information
    "DocumentationURL"base URL for the paclet's web documentation
    "URL"a URL to a home page for the paclet
    "Support"where to go for support
    "Icon"relative path to a file containing an icon image
    "UUID"a unique ID
    "Extensions"specification of what the paclet provides
    "Location"the location of the paclet, either a local path or a paclet site URL
  • You can use property notation to extract data from a paclet object: PacletObject[…]["prop"].
  • Properties that can be extracted include any metadata keys listed above, plus:
  • "Enabled"whether the paclet is enabled or disabled
    "Context"the Wolfram Language context or contexts the paclet exports
    "AssetLocation"obtain a path to files inside a paclet
    "PacletInfo"the entire contents of the PacletInfo.wl file as an Association
    Allthe entire list of metadata
  • Information of a PacletObject includes the following properties:
  • "Name"name of the paclet; required
    "Version"version as a string; required
    "WolframVersion"what version(s) of the Wolfram Language the paclet is compatible with
    "SystemID"list of $SystemID values the paclet is compatible with
    "Loading"when the paclet's .wl files load
    "AutoUpdating"whether the paclet automatically updates itself
    "Enabled"whether the paclet is enabled or disabled
    "Description"short description of the paclet
    "Category"a category or list of categories describing the functionality
    "Keywords"keywords relevant to the functionality
    "Creator"author or company information
    "URL"a URL to a home page for the paclet
    "UUID"a unique ID
    "Context"the Wolfram Language context or contexts the paclet exports
    "Location"the location of the paclet, either a local path or a paclet site URL

Examples

open allclose all

Basic Examples  (4)

The WebSearch paclet is a built-in component of the Wolfram System:

Get the installed location:

See the full set of properties and their values:

Examine a paclet that resides on the Wolfram paclet server:

Extract multiple properties at once:

Information works on PacletObject expressions:

Using PacletObject on a name that does not correspond to an installed paclet fails:

Scope  (1)

You can directly create PacletObject expressions:

The expression can be written to a file to create a PacletInfo.wl descriptor file:

Properties & Relations  (3)

PacletFind returns PacletObject expressions for locally installed paclets:

PacletFindRemote returns PacletObject expressions for paclets available for download from paclet sites:

PacletInstall returns a PacletObject:

Uninstall the paclet:

Wolfram Research (2020), PacletObject, Wolfram Language function, https://reference.wolfram.com/language/ref/PacletObject.html.

Text

Wolfram Research (2020), PacletObject, Wolfram Language function, https://reference.wolfram.com/language/ref/PacletObject.html.

CMS

Wolfram Language. 2020. "PacletObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/PacletObject.html.

APA

Wolfram Language. (2020). PacletObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/PacletObject.html

BibTeX

@misc{reference.wolfram_2024_pacletobject, author="Wolfram Research", title="{PacletObject}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/PacletObject.html}", note=[Accessed: 21-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_pacletobject, organization={Wolfram Research}, title={PacletObject}, year={2020}, url={https://reference.wolfram.com/language/ref/PacletObject.html}, note=[Accessed: 21-November-2024 ]}