From: garciadeblas <gerardo.garciadeblas@telefonica.com>
Date: Wed, 15 Nov 2023 09:11:07 +0000 (+0100)
Subject: Update README with improved instructions to install osmclient locally
X-Git-Tag: release-v16.0-start~18
X-Git-Url: https://osm.etsi.org/gitweb/?a=commitdiff_plain;h=refs%2Fchanges%2F67%2F14167%2F1;p=osm%2Fosmclient.git

Update README with improved instructions to install osmclient locally

Change-Id: Iabfd2bc332416cf1e68045fe02ab420cba709c9f
Signed-off-by: garciadeblas <gerardo.garciadeblas@telefonica.com>
---

diff --git a/README.md b/README.md
index c53049e..c8ec7e8 100644
--- a/README.md
+++ b/README.md
@@ -20,40 +20,37 @@ OSM client library and console script
 
 ## Installation
 
-### From git-repo
-
 ```bash
-# Ubuntu 18.04 pre-requirements
-sudo apt-get install python3-pip libcurl4-openssl-dev libssl-dev
-# CentOS pre-requirements
-# sudo yum install python3-pip libcurl-devel gnutls-devel
-sudo -H python3 -m pip install python-magic
-# Install OSM Information model
-sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/IM --upgrade
-# Install OSM client from the git repo.
-# You can install the latest client from master branch in this way:
-sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/osmclient
-# You could also install a specific tag/version in this way
-# sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v7.0.0rc1
+# Ubuntu pre-requirements
+sudo apt-get install python3-pip
+# Centos pre-requirements
+# sudo yum install python3-pip
 ```
 
-### From cloned repo (for developers)
+Clone the osmclient repo:
 
-```
-# Ubuntu 18.04 pre-requirements
-sudo apt-get install python3-pip libcurl4-openssl-dev libssl-dev
-# Centos pre-requirements
-# sudo yum install python3-pip libcurl-devel gnutls-devel
-sudo -H python3 -m pip install python-magic
-# Install OSM Information model
-sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/IM --upgrade
-# Clone the osmclient repo and install OSM client from the git repo.
+```bash
 git clone https://osm.etsi.org/gerrit/osm/osmclient
 cd osmclient
-python3 -m pip install --user -e .
+```
+
+Finally install osmclient with pip. For development, you should install osmclient in editable mode (`--user -e`):
+
+```bash
+# Install osmclient
+python3 -m pip install --user . -r requirements.txt -r requirements-dev.txt
+# Install osmclient in editable mode (-e)
+# python3 -m pip install --user -e . -r requirements.txt -r requirements-dev.txt
 # logout and login so that PATH can be updated. Executable osm will be found in /home/ubuntu/.local/bin
 ```
 
+After logging out and in, you can check that osm is running with:
+
+```bash
+which osm
+osm version
+```
+
 ## Setup
 
 Set the OSM_HOSTNAME variable to the host of the OSM server (default: localhost).
@@ -171,7 +168,6 @@ Then you can add the following to your $HOME/.bashrc file:
 
 ## Future work
 
-- Create command classes for list and show operations
 - Option `-c` for list and show operations to filter output and show only selected columns
 - Option `-o <FORMAT>` to adapt output format (table, csv, yaml, json, jsonpath)
 - Command ns-status to show the deployment status (RO) and configuration status (VCA) in an appealing format