Skip to content

Commit

Permalink
docs: Add listing of full dependencies (#20)
Browse files Browse the repository at this point in the history
* Note that this is no longer an example implementation but can be used.
* Add "Dependencies" section to README.
   - Note that cvmfs-venv relies only on Bash shell builtins, cat, ed, sed,
     and Python 3.3+.
  • Loading branch information
matthewfeickert authored Mar 20, 2023
1 parent 11d2e45 commit 8e9afd3
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cvmfs-venv

Example implementation of getting a Python virtual environment to work with CVMFS [LCG views][LCG_info]. This is done by adding additional hooks to the Python virtual environment's `bin/activate` script.
Simple command line utility for getting a Python virtual environment to work with CVMFS [LCG views][LCG_info]. This is done by adding additional hooks to the Python virtual environment's `bin/activate` script.

[LCG_info]: https://lcginfo.cern.ch/

Expand Down Expand Up @@ -132,6 +132,16 @@ Requires: setuptools, numpy
Required-by:
```

## Dependencies

`cvmfs-venv` has no dependencies beyond the ones it aims to extend: A Linux operating system that has CVMFS installed on it with a Python 3.3+ runtime with a functioning [`venv` module][venv docs].

A full listing of all programs used outside of Bash shell builtins are:
* `cat`
* `ed`
* `sed`
* Python 3.3+ with `pip`

## Why is this needed?

When an LCG view or an ATLAS computing environment that uses software from CVFMS is setup, it manipulates and alters the [`PYTHONPATH` environment variable][PYTHONPATH docs].
Expand Down

0 comments on commit 8e9afd3

Please sign in to comment.