2023-06-01 00:06:02 -05:00
<!doctype html>
< html lang = "en" class = "no-js" >
2023-05-26 18:42:22 -05:00
< head >
2023-06-01 00:06:02 -05:00
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< link rel = "canonical" href = "https://viv.dayl.in/" >
< link rel = "next" href = "cli/" >
< link rel = "icon" href = "https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" >
< meta name = "generator" content = "mkdocs-1.4.3, mkdocs-material-9.1.15" >
< title > viv< / title >
< link rel = "stylesheet" href = "assets/stylesheets/main.26e3688c.min.css" >
< link rel = "stylesheet" href = "assets/stylesheets/palette.ecc896b0.min.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" crossorigin >
< link rel = "stylesheet" href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" >
< style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style >
< script > _ _md _scope = new URL ( "." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script >
2023-05-26 18:42:22 -05:00
< / head >
2023-06-01 00:06:02 -05:00
< body dir = "ltr" data-md-color-scheme = "slate" data-md-color-primary = "deep-purple" data-md-color-accent = "indigo" >
< script > var palette = _ _md _get ( "__palette" ) ; if ( palette && "object" == typeof palette . color ) for ( var key of Object . keys ( palette . color ) ) document . body . setAttribute ( "data-md-color-" + key , palette . color [ key ] ) < / script >
< input class = "md-toggle" data-md-toggle = "drawer" type = "checkbox" id = "__drawer" autocomplete = "off" >
< input class = "md-toggle" data-md-toggle = "search" type = "checkbox" id = "__search" autocomplete = "off" >
< label class = "md-overlay" for = "__drawer" > < / label >
< div data-md-component = "skip" >
< a href = "#viv" class = "md-skip" >
Skip to content
< / a >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "." title = "viv" class = "md-header__button md-logo" aria-label = "viv" data-md-component = "logo" >
< img src = "https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg >
< / label >
< div class = "md-header__title" data-md-component = "header-title" >
< div class = "md-header__ellipsis" >
< div class = "md-header__topic" >
< span class = "md-ellipsis" >
viv
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
viv
< / span >
< / div >
< / div >
< / div >
< form class = "md-header__option" data-md-component = "palette" >
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "slate" data-md-color-primary = "deep-purple" data-md-color-accent = "indigo" aria-label = "Switch to light mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to light mode" for = "__palette_2" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg >
< / label >
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "default" data-md-color-primary = "deep-purple" data-md-color-accent = "indigo" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_2" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg >
< / label >
< / form >
< label class = "md-header__button md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< / label >
< div class = "md-search" data-md-component = "search" role = "dialog" >
< label class = "md-search__overlay" for = "__search" > < / label >
< div class = "md-search__inner" role = "search" >
< form class = "md-search__form" name = "search" >
< input type = "text" class = "md-search__input" name = "query" aria-label = "Search" placeholder = "Search" autocapitalize = "off" autocorrect = "off" autocomplete = "off" spellcheck = "false" data-md-component = "search-query" required >
< label class = "md-search__icon md-icon" for = "__search" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg >
< / label >
< nav class = "md-search__options" aria-label = "Search" >
< button type = "reset" class = "md-search__icon md-icon" title = "Clear" aria-label = "Clear" tabindex = "-1" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" / > < / svg >
< / button >
< / nav >
< / form >
< div class = "md-search__output" >
< div class = "md-search__scrollwrap" data-md-scrollfix >
< div class = "md-search-result" data-md-component = "search-result" >
< div class = "md-search-result__meta" >
Initializing search
< / div >
< ol class = "md-search-result__list" role = "presentation" > < / ol >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "md-header__source" >
< a href = "https://github.com/daylinmorgan/viv" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
daylinmorgan/viv
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< main class = "md-main" data-md-component = "main" >
< div class = "md-main__inner md-grid" >
< div class = "md-sidebar md-sidebar--primary" data-md-component = "sidebar" data-md-type = "navigation" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "." title = "viv" class = "md-nav__button md-logo" aria-label = "viv" data-md-component = "logo" >
< img src = "https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt = "logo" >
< / a >
viv
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/daylinmorgan/viv" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc. --> < path d = "M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z" / > < / svg >
< / div >
< div class = "md-source__repository" >
daylinmorgan/viv
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
< li class = "md-nav__item md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
viv
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "." class = "md-nav__link md-nav__link--active" >
viv
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#setup" class = "md-nav__link" >
Setup
< / a >
< nav class = "md-nav" aria-label = "Setup" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#pypi-not-recommended" class = "md-nav__link" >
Pypi (Not Recommended)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#usage" class = "md-nav__link" >
Usage
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#additional-features" class = "md-nav__link" >
Additional Features
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#alternatives" class = "md-nav__link" >
Alternatives
< / a >
< nav class = "md-nav" aria-label = "Alternatives" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#pip-run" class = "md-nav__link" >
pip-run
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#pipx" class = "md-nav__link" >
pipx
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "cli/" class = "md-nav__link" >
cli
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-sidebar md-sidebar--secondary" data-md-component = "sidebar" data-md-type = "toc" >
< div class = "md-sidebar__scrollwrap" >
< div class = "md-sidebar__inner" >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#setup" class = "md-nav__link" >
Setup
< / a >
< nav class = "md-nav" aria-label = "Setup" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#pypi-not-recommended" class = "md-nav__link" >
Pypi (Not Recommended)
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#usage" class = "md-nav__link" >
Usage
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#additional-features" class = "md-nav__link" >
Additional Features
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#alternatives" class = "md-nav__link" >
Alternatives
< / a >
< nav class = "md-nav" aria-label = "Alternatives" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#pip-run" class = "md-nav__link" >
pip-run
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#pipx" class = "md-nav__link" >
pipx
< / a >
< / li >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 id = "viv" > viv< / h1 >
< div align = "center" >
< a href = "https://github.com/daylinmorgan/viv" >
< img src = "https://raw.githubusercontent.com/daylinmorgan/viv/main/assets/logo.svg" alt = "Logo" width = 500 >
< / a >
< p align = "center" >
viv isn't venv
< / p >
< p align = "center" >
< a href = "viv.dayl.in" > Documentation< / a >
< / p >
< / div >
< p > Try before you buy!< / p >
< pre > < code class = "language-sh" > python3 < (curl -fsSL viv.dayl.in/viv.py) run pycowsay -- " viv isn't venv\!"
< / code > < / pre >
< hr / >
< p > < code > Viv< / code > is a standalone dependency-free < code > venv< / code > creator.< / p >
< p > These < code > venvs< / code > can be identified by name or by their specification.
In any case they will be re-used across scripts (and generated on-demand, if needed).< / p >
< p > < strong > Importantly< / strong > , < code > viv< / code > will also remove your user site directory.
(view with: < code > python -m 'import site;print(site.USER_SITE)'< / code > ).< / p >
< p > < code > Viv< / code > 's uncompromising insistence on portability means that it will always (1) only use the standard library (2) never exceed a single script.< / p >
< p > For that reason any usage of the < code > CLI< / code > can be accomplished using a remote copy as seen in the below install command.< / p >
< h2 id = "setup" > Setup< / h2 >
< p > Run the below command to install < code > viv< / code > .< / p >
< pre > < code class = "language-sh" > python3 < (curl -fsSL viv.dayl.in/viv.py) manage install
< / code > < / pre >
< p > To access < code > viv< / code > from within scripts you should add it's location to your < code > PYTHONPATH< / code > .
By default < code > viv< / code > will be installed to < code > $XDG_DATA_HOME/viv< / code > or < code > ~/.local/share/viv< / code > you can customize this with < code > --src< / code > .< / p >
< pre > < code class = "language-sh" > export PYTHONPATH=" $PYTHONPATH:$HOME/.local/share/viv"
< / code > < / pre >
< p > Advanced users may recognize that principally,
the module just needs to be recognized at run time
and the single script < a href = "https://github.com/daylinmorgan/viv/blob/main/src/viv/viv.py" > < code > viv.py< / code > < / a > can be invoked directly for the CLI.
How you accomplish these options is ultimately up to you but the above instructions can get you started.< / p >
< h3 id = "pypi-not-recommended" > Pypi (Not Recommended)< / h3 >
< pre > < code class = "language-sh" > pip install viv
< / code > < / pre >
< p > Why is this < em > not recommended< / em > ? Mainly, because < code > viv< / code > is all about hacking your < code > sys.path< / code > .
Placing it in it's own virtual environment or installing in a user site directory may complicate this endeavor.< / p >
< h2 id = "usage" > Usage< / h2 >
< p > In any python script with external dependencies you can add this line,
to automate < code > vivenv< / code > creation and installation of dependencies.< / p >
< pre > < code class = "language-python" > __import__(" viv" ).use(" click" )
< / code > < / pre >
< p > To remove all < code > vivenvs< / code > you can use the below command:< / p >
< pre > < code class = "language-sh" > viv remove $(viv list -q)
< / code > < / pre >
< p > To remove < code > viv< / code > all together you can use the included < code > purge< / code > command:< / p >
< pre > < code class = "language-sh" > python3 < (curl -fsSL viv.dayl.in/viv.py) manage purge
< / code > < / pre >
< h2 id = "additional-features" > Additional Features< / h2 >
< p > An experimental feature of < code > viv< / code > is generating shim's that leverage the principles of < code > viv< / code > .
These shims would operate similar to < code > pipx< / code > in which you can specify a command line app to "install".< / p >
< p > < em > Note< / em > that < code > --standalone< / code > will auto-generate a code-golfed minified version of < code > viv< / code > to accomplish the same basic task as using a local copy of < code > viv< / code > .
After generating this a standalone < code > shim< / code > you can freely use this script across unix machines which have < code > python> 3.8< / code > .
See < a href = "https://github.com/daylinmorgan/viv/blob/dev/examples/black" > examples/black< / a > for output of below command.< / p >
< pre > < code class = "language-sh" > python3 < (curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --freeze
< / code > < / pre >
< h2 id = "alternatives" > Alternatives< / h2 >
< h3 id = "pip-run" > < a href = "https://github.com/jaraco/pip-run" > pip-run< / a > < / h3 >
< pre > < code class = "language-sh" > pip-run (10.0.5)
├── autocommand (2.2.2)
├── jaraco-context (4.3.0)
├── jaraco-functools (3.6.0)
│ └── more-itertools (9.1.0)
├── jaraco-text (3.11.1)
│ ├── autocommand (2.2.2)
│ ├── inflect (6.0.2)
│ │ └── pydantic> =1.9.1 (1.10.5)
│ │ └── typing-extensions> =4.2.0 (4.5.0)
│ ├── jaraco-context> =4.1 (4.3.0)
│ ├── jaraco-functools (3.6.0)
│ │ └── more-itertools (9.1.0)
│ └── more-itertools (9.1.0)
├── more-itertools> =8.3 (9.1.0)
├── packaging (23.0)
├── path> =15.1 (16.6.0)
├── pip> =19.3 (23.0.1)
└── platformdirs (3.1.0)
< / code > < / pre >
< h3 id = "pipx" > < a href = "https://github.com/pypa/pipx/" > pipx< / a > < / h3 >
< pre > < code class = "language-sh" > pipx (1.1.0)
├── argcomplete> =1.9.4 (2.1.1)
├── packaging> =20.0 (23.0)
└── userpath> =1.6.0 (1.8.0)
└── click (8.1.3)
< / code > < / pre >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< div class = "md-footer-meta md-typeset" >
< div class = "md-footer-meta__inner md-grid" >
< div class = "md-copyright" >
Made with
< a href = "https://squidfunk.github.io/mkdocs-material/" target = "_blank" rel = "noopener" >
Material for MkDocs
< / a >
< / div >
< / div >
< / div >
< / footer >
< / div >
< div class = "md-dialog" data-md-component = "dialog" >
< div class = "md-dialog__inner md-typeset" > < / div >
< / div >
< script id = "__config" type = "application/json" > { "base" : "." , "features" : [ "navigation.indexes" ] , "search" : "assets/javascripts/workers/search.208ed371.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script >
< script src = "assets/javascripts/bundle.b4d07000.min.js" > < / script >
< / body >
< / html >
