Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit dca8a39

Browse files
author
Yan
committed
Corrected CHANGES.md to reflect 0.8.0 release features
1 parent bbce4af commit dca8a39

File tree

1 file changed

+24
-53
lines changed

1 file changed

+24
-53
lines changed

README.rst

Lines changed: 24 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ YANG Development Kit (Python)
1414
Overview
1515
--------
1616

17-
The YANG Development Kit (YDK) is a Software Development Kit that provides API's that are modeled in YANG. The main goal of YDK is to reduce the learning curve of YANG data models by expressing the model semantics in an API and abstracting protocol/encoding details. YDK is composed of a core package that defines services and providers, plus one or more module bundles that are based on YANG models.
17+
The YANG Development Kit (YDK) is a Software Development Kit that provides API's that are modeled in YANG.
18+
The main goal of YDK is to reduce the learning curve of YANG data models by expressing the model semantics in an API and abstracting protocol/encoding details.
19+
YDK is composed of a core package that defines services and providers, plus one or more module bundles that are based on YANG models.
1820

1921
Backward Compatibility
2022
----------------------
21-
Please see `the release notes <https://github.com/CiscoDevNet/ydk-py/releases/tag/0.6.0>`_ and `documentation <http://ydk.cisco.com/py/docs/backward_compatibility.html>`_ for details on some backward incompatible changes introduced as part of the 0.6.0 release.
23+
Please see `the release notes <https://github.com/CiscoDevNet/ydk-py/releases/tag/0.6.0>`_ and `documentation <http://ydk.cisco.com/py/docs/backward_compatibility.html>`_
24+
for details on some backward incompatible changes introduced as part of the 0.6.0 release.
2225

2326
Docker
2427
------
@@ -27,8 +30,6 @@ A `docker image <https://docs.docker.com/engine/reference/run/>`_ is automatical
2730

2831
To use the docker image, `install docker <https://docs.docker.com/install/>`_ on your system and run the below command. See the `docker documentation <https://docs.docker.com/engine/reference/run/>`_ for more details::
2932

30-
.. code-block:: sh
31-
3233
docker run -it ydkdev/ydk-py
3334

3435

@@ -44,8 +45,6 @@ Linux
4445

4546
The following packages must be present in your system before installing YDK-Py::
4647

47-
.. code-block:: sh
48-
4948
$ sudo apt-get update > /dev/null
5049
$ sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
5150
$ sudo apt-get install gdebi-core python3-dev python-dev libtool-bin
@@ -72,8 +71,6 @@ For Bionic (Ubuntu 18.04.1)::
7271

7372
The following packages must be present in your system before installing YDK-Py. Currently, only Centos7/RHEL7 are known to work::
7473

75-
.. code-block:: sh
76-
7774
# The below may not be required on Fedora27
7875
$ sudo yum install epel-release
7976
$ sudo yum install libssh-devel gcc-c++ python-devel
@@ -92,9 +89,8 @@ MacOS
9289

9390
It is required to install Xcode command line tools, `homebrew <http://brew.sh>`_ and the following homebrew packages on your system before installing YDK-Py.
9491

95-
You can download the latest python package from `here <https://www.python.org/downloads/>`_. Please do not use the homebrew version of python as it causes issues with installing ydk packages. Please execute ``brew rm python python3`` to remove any homebrew python packages::
96-
97-
.. code-block:: sh
92+
You can download the latest python package from `here <https://www.python.org/downloads/>`_.
93+
Please do not use the homebrew version of python as it causes issues with installing ydk packages. Please execute ``brew rm python python3`` to remove any homebrew python packages::
9894

9995
$ xcode-select --install
10096
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
@@ -148,23 +144,19 @@ Install gRPC
148144
Instal YDK gNMI library
149145
~~~~~~~~~~~~~~~~~~~~~~~
150146

151-
Ubuntu
147+
**Ubuntu**
152148

153-
For Xenial (Ubuntu 16.04.4):
154-
155-
.. code-block:: sh
149+
For Xenial (Ubuntu 16.04.4)::
156150

157151
wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.0/xenial/libydk_gnmi_0.4.0-1_amd64.deb
158152
sudo gdebi libydk_gnmi_0.4.0-1_amd64.deb
159153

160-
For Bionic (Ubuntu 18.04.1):
161-
162-
.. code-block:: sh
154+
For Bionic (Ubuntu 18.04.1)::
163155

164156
wget https://devhub.cisco.com/artifactory/debian-ydk/0.8.0/bionic/libydk_gnmi_0.4.0-1_amd64.deb
165157
sudo gdebi libydk_gnmi_0.4.0-1_amd64.deb
166158

167-
CentOS
159+
**CentOS**
168160

169161
.. code-block:: sh
170162
@@ -174,9 +166,7 @@ Runtime environment
174166
~~~~~~~~~~~~~~~~~~~
175167

176168
There is an open issue with gRPC on Centos/Fedora, which requires an extra step before running any YDK gNMI application. See this issue on `GRPC GitHub <https://github.com/grpc/grpc/issues/10942#issuecomment-312565041>`_
177-
for details. As a workaround, the YDK based application runtime environment must include setting of `LD_LIBRARY_PATH` variable:
178-
179-
.. code-block:: sh
169+
for details. As a workaround, the YDK based application runtime environment must include setting of `LD_LIBRARY_PATH` variable::
180170

181171
$ PROTO="/Your-Protobuf-and-Grpc-installation-directory"
182172
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PROTO/grpc/libs/opt:$PROTO/protobuf-3.5.0/src/.libs:/usr/local/lib64
@@ -187,9 +177,9 @@ How to install
187177
Quick Install
188178
~~~~~~~~~~~~~
189179

190-
You can install the latest model packages from the Python package index. Note that, in some systems, you need to install the new package as root. You get a fully operational YDK environment by installing the ``cisco-ios-xr`` and/or ``cisco-ios-xe`` bundle(s) (depending on whether you're developing for an IOS XR or IOS XE platform) which automatically installs all other YDK-related packages (``ydk``, ``openconfig`` and ``ietf`` packages)::
191-
192-
.. code-block:: sh
180+
You can install the latest model packages from the Python package index. Note that, in some systems, you need to install the new package as root.
181+
You get a fully operational YDK environment by installing the ``cisco-ios-xr`` and/or ``cisco-ios-xe`` bundle(s) (depending on whether you're developing for an IOS XR or IOS XE platform),
182+
which automatically installs all other YDK-related packages (``ydk``, ``openconfig`` and ``ietf`` packages)::
193183

194184
$ pip install ydk-models-cisco-ios-xr
195185
$ pip install ydk-models-cisco-ios-xe
@@ -200,35 +190,27 @@ Alternatively, you can perform a partial installation. If you only want to inst
200190

201191
If you only want to install the ``ietf`` bundle and its dependencies (``ydk`` package), execute::
202192

203-
.. code-block:: sh
204-
205193
$ pip install ydk-models-ietf
206194

207195
To installation of model bundles on CentOS/RedHat platforms require special handling; please follow the below steps.
208196

209-
**Python2.7:**
210-
211-
.. code-block:: sh
197+
**Python2.7**::
212198

213199
pip install ydk
214200
pip install --install-option="--install-purelib=/usr/lib64/python2.7/site-packages" --no-deps ydk-models-ietf
215201
pip install --install-option="--install-purelib=/usr/lib64/python2.7/site-packages" --no-deps ydk-models-openconfig
216202
pip install --install-option="--install-purelib=/usr/lib64/python2.7/site-packages" --no-deps ydk-models-cisco-ios-xr
217203
pip install --install-option="--install-purelib=/usr/lib64/python2.7/site-packages" --no-deps ydk-models-cisco-ios-xe
218204

219-
**Python3.4:**
220-
221-
.. code-block:: sh
205+
**Python3.4**::
222206

223207
pip install ydk
224208
pip install --install-option="--install-purelib=/usr/lib64/python3.4/site-packages" --no-deps ydk-models-ietf
225209
pip install --install-option="--install-purelib=/usr/lib64/python3.4/site-packages" --no-deps ydk-models-openconfig
226210
pip install --install-option="--install-purelib=/usr/lib64/python3.4/site-packages" --no-deps ydk-models-cisco-ios-xr
227211
pip install --install-option="--install-purelib=/usr/lib64/python3.4/site-packages" --no-deps ydk-models-cisco-ios-xe
228212

229-
**Python3.6:**
230-
231-
.. code-block:: sh
213+
**Python3.6**::
232214

233215
pip install ydk
234216
pip install --install-option="--install-purelib=/usr/lib64/python3.6/site-packages" --no-deps ydk-models-ietf
@@ -239,61 +221,50 @@ To installation of model bundles on CentOS/RedHat platforms require special hand
239221
Installing from Source
240222
~~~~~~~~~~~~~~~~~~~~~~
241223

242-
If you prefer not to use the YDK packages in the Python package index, you need to install manually the ``ydk`` core package and then the model bundles you plan to use. To install the ``ydk`` core package, execute::
243-
244-
.. code-block:: sh
224+
If you prefer not to use the YDK packages in the Python package index, you need to install manually the ``ydk`` core package and then the model bundles you plan to use.
225+
To install the ``ydk`` core package, execute::
245226

246227
$ cd core
247228
core$ python setup.py sdist
248229
core$ pip install dist/ydk*.gz
249230

250-
Once you have installed the ``ydk`` core package, you can install one more model bundles. Note that some bundles have dependencies on other bundles. Those dependencies are already captured in the bundle package. Make sure you install the desired bundles in the order below. To install the ``ietf`` bundle, execute::
251-
252-
.. code-block:: sh
231+
Once you have installed the ``ydk`` core package, you can install one more model bundles. Note that some bundles have dependencies on other bundles.
232+
Those dependencies are already captured in the bundle package. Make sure you install the desired bundles in the order below. To install the ``ietf`` bundle, execute::
253233

254234
core$ cd ../ietf
255235
ietf$ python setup.py sdist
256236
ietf$ pip install dist/ydk*.gz
257237

258238
To install the ``openconfig`` bundle, execute::
259239

260-
.. code-block:: sh
261-
262240
ietf$ cd ../openconfig
263241
openconfig$ python setup.py sdist
264242
openconfig$ pip install dist/ydk*.gz
265243

266244
To install the ``cisco-ios-xr`` bundle, execute::
267245

268-
.. code-block:: sh
269-
270246
openconfig$ cd ../cisco-ios-xr
271247
cisco-ios-xr$ python setup.py sdist
272248
cisco-ios-xr$ pip install dist/ydk*.gz
273249
cisco-ios-xr$ cd ..
274250

275251
Using a Virtual Environment
276252
~~~~~~~~~~~~~~~~~~~~~~~~~~~
277-
You may want to perform the installation under a Python virtual environment (`virtualenv <https://pypi.python.org/pypi/virtualenv/>`_/`virtualenvwrapper <https://pypi.python.org/pypi/virtualenvwrapper>`_). A virtual environment allows you to install multiple versions of YDK if needed. In addition, it prevents any potential conflicts between package dependencies in your system.
253+
You may want to perform the installation under a Python virtual environment (`virtualenv <https://pypi.python.org/pypi/virtualenv/>`_/`virtualenvwrapper <https://pypi.python.org/pypi/virtualenvwrapper>`_).
254+
A virtual environment allows you to install multiple versions of YDK if needed. In addition, it prevents any potential conflicts between package dependencies in your system.
278255

279256
To install virtual environment support in your system, execute::
280257

281-
.. code-block:: sh
282-
283258
$ pip install virtualenv virtualenvwrapper
284259
$ source /usr/local/bin/virtualenvwrapper.sh
285260

286261
In some systems (e.g. Debian-based Linux), you need to install support for Python virtual environments as root::
287262

288-
.. code-block:: sh
289-
290263
$ sudo pip install virtualenv virtualenvwrapper
291264
$ source /usr/local/bin/virtualenvwrapper.sh
292265

293266
Create a new virtual environment::
294267

295-
.. code-block:: sh
296-
297268
$ mkvirtualenv -p python2.7 ydk-py
298269

299270
At this point, you can perform the quick install or the installation from source described above. Take into account that must not attempt to install YDK as root under a virtual environment.

0 commit comments

Comments
 (0)