reftool
reftool is a command line interface for accessing reference archives. It allows to display references, copy single reference items into the clipboard and optionally to apply encodings to a copied reference. An example implementation for a reference archive is the usd-reference-archive.
Installation
reftool can be installed via pip, either by installing from PyPi:
[user@host ~]$ pip3 install --user reftool
or by building and installing it manually:
[user@host ~]$ git clone https://github.com/usdAG/reftool
[user@host ~]$ cd reftool
[user@host ~]$ pip3 install -r requirements.txt
[user@host ~]$ python3 setup.py sdist
[user@host ~]$ pip3 install --user dist/reftool-*
reftool supports autocompletion for bash. To take advantage of autocompletion, you
need to have the completion-helpers project
installed. If setup correctly, just copying the completion script
to your ~/.bash_completion.d folder enables autocompletion.
Configuration
During the installation, reftool creates a configuration file ~/.config/reftool.ini.
Inside this file, the path for the reference archive and some other display related options
are set. You can adjust these options to your own preferences.
In order to be useful, at least one reference archive should be available within reftools reference path. The usd-reference-archive is one example for a reftool compatible archive. You can have several different archives within your reference path.
For a default installation, the following commands can be used to setup a reference archive:
[user@host ~]$ mkdir -p ~/.local/share/reftool-archives
[user@host ~]$ cd ~/.local/share/reftool-archives
[user@host ~]$ git clone https://github.com/usdAG/usd-reference-archive
1 maintainer
Metadata
1 maintainer
Release files for reftool 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| reftool-2.2.0.tar.gz | 22.5 kB | Without provenance | Details |
Release files / reftool-2.2.0.tar.gz
| Download URL | reftool-2.2.0.tar.gz |
|---|---|
| Size | 22.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d2fc95065fd7ad91a57444ee823be982095e05c4b1c2d2f7383bce42d298c245
|
|
BLAKE2b-256 checksum How to use checksums |
9173f83743e3c953a99c14dec6d2198aaf979c80b112182611c9279969d3971e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.8
|
Security for reftool 2.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
