Commit df589f85 authored by Sachin Patil's avatar Sachin Patil

ReadMe added

parent 95de498e
* setV
Light-weight Python virtual environment manager
For more than a year 'setV' was lying under
[[https://github.com/psachin/bash_scripts]]. I use it as an alternative
to [[https://virtualenvwrapper.readthedocs.org/][virtualenvwrapper]]. It is a bash function and provides basic
features such as:
- Create new virtual environment
- Delete existing virtual environment(s)
- List existing virtual environment(s)
- In case you don't remember virtual environment name, TAB completion
works :)
** Installation
Run the command
#+BEGIN_SRC sh
curl https://raw.githubusercontent.com/psachin/setV/master/install.sh | sh -
#+END_SRC
** Usage
- First of all, the command is =setv=
- When you install =setv=, the installation script will ask you to
source =~/.bashrc= or =~/.bash_profile=. Please do that.
*** Activating existing environment(s)
#+BEGIN_SRC sh
setv VIRTUAL_ENVIRONMENT_NAME
#+END_SRC
For example
#+BEGIN_SRC sh
setv rango
#+END_SRC
*** List all virtual environment(s)
You can list existing virtual environments by typing
#+BEGIN_SRC sh
setv -l
# or
setv [TAB] [TAB]
#+END_SRC
*** Create virtual environment
#+BEGIN_SRC sh
setv -n rango
#+END_SRC
*** Delete virtual environment
#+BEGIN_SRC sh
setv -d rango
#+END_SRC
*** Switch to another virtual environment
#+BEGIN_SRC sh options
# Assuming you are in 'rango', switch to 'tango' using
setv tango
#+END_SRC
*** In case you don't fully remember virtual environment name
- Bash like TAB completion works with virtual environment names
** Contribution
- Create new issue.
- Patches are welcome for existing issues.
** License
GNU GPL version 3. See LICENSE file.
......@@ -33,7 +33,7 @@
# To deactivate, type:
# $ deactivate
# TODO (Testing):
# Testing needed:
# - Create virtualenv with command something like: setv -n new_virt_name
# - Delete virtualenv with command something like: setv -d old_virt_name
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment