From aa902666e33e4706b2fe54c9bdaf0b8dd3db26c2 Mon Sep 17 00:00:00 2001 From: sfisher Date: Tue, 19 Mar 2024 14:14:27 -0700 Subject: [PATCH 1/2] adding warnings about python versioning. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 023427c..1d16465 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ The Counter Processor is a Python 3 (3.10) script for processing dataset access statistics from logs using the COUNTER Code of Practice for Research Data. +I'd strongly recommend installing python using a tool such as `pyenv` (*nix/MacOS) or `anaconda` or `miniconda` +for managing multiple Python versions and dependencies separate from versions of Python +installed by the operating system. `pyenv` also has the nice feature of automatically +using the correct version of python when you `cd` into a project directory with a `.python-version` +file that indicates the version of python to use. + +If using python from the global OS version, you may need to use `pip3` instead of `pip` and +`python3` instead of `python` in the examples below. If you have a local version of +python installed, you can use `pip` and `python` as shown in the examples. + The software assumes you area already logging your COUNTER dataset *investigations* and *requests* to a log file using a format somewhat similar to extended log format. The COUNTER Code of Practice requires that descriptive metadata be submitted along with statistics--these items are included in logs to ease later processing. Log items are separated by tabs (\t) and any missing values may be logged with a dash (-) or by a an empty string. From 97ed75c2858eb2e8c91088024709ae0e01397e0a Mon Sep 17 00:00:00 2001 From: sfisher Date: Tue, 19 Mar 2024 14:17:35 -0700 Subject: [PATCH 2/2] adding info about python versioning --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d16465..1f826cb 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,9 @@ I'd strongly recommend installing python using a tool such as `pyenv` (*nix/MacO for managing multiple Python versions and dependencies separate from versions of Python installed by the operating system. `pyenv` also has the nice feature of automatically using the correct version of python when you `cd` into a project directory with a `.python-version` -file that indicates the version of python to use. +file that indicates the version of python to use. `venv` is a built-in tool for creating +virtual environments for Python and does something similar to `pyenv` and can work in tandem +with it. If using python from the global OS version, you may need to use `pip3` instead of `pip` and `python3` instead of `python` in the examples below. If you have a local version of