Skip to content

Commit

Permalink
Removed references to ydk.io URL
Browse files Browse the repository at this point in the history
  • Loading branch information
ygorelik committed Aug 31, 2023
1 parent f5c46a0 commit 67ec6ae
Show file tree
Hide file tree
Showing 38 changed files with 42 additions and 51 deletions.
4 changes: 2 additions & 2 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### 2023-03-31 version 0.8.6.5
### 2023-08-31 version 0.8.6.5

#### New features and enhancements
* Added support for Ubuntu:jammy (22.04)

#### Resolved GitHub issues
* Segmentation Fault on Python application exit with Python 3.9.5 ([#1050](https://github.com/CiscoDevNet/ydk-gen/issues/1050))

* ydk.io and ciscodevnet.github.io/ydk-py/ not working correctly ([#1088](https://github.com/CiscoDevNet/ydk-gen/issues/1088))

### 2023-01-31 version 0.8.6.4

Expand Down
2 changes: 0 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
FROM ubuntu:bionic

MAINTAINER http://ydk.io

COPY . /root/ydk-gen

RUN echo 'Installing dependencies'
Expand Down
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ YANG Development Kit
- [Generate and install model bundle](#generate-and-install-model-bundle)
- [Writing your first app](#writing-your-first-app)
- [Generating Documentation](#generating-documentation)
- [Generating an "Adhoc" YDK-Py Bundle](#generating-an-adhoc-ydk-py-bundle)
- [Generating an "Adhoc" Bundle](#generating-an-adhoc-bundle)
- [Notes](#notes)
- [Python requirements](#python-requirements)
- [C++ requirements](#c-requirements)
Expand Down Expand Up @@ -88,7 +88,7 @@ Other tools and libraries are used to deliver `YDK` functionality:
The output of ydk-gen is either a core package, that defines main services and providers,
or add-on service package like gNMI Service, or a module bundle, consisting of programming language APIs derived from YANG models.
Each module bundle is generated using a bundle profile and the ydk-gen tool.
Developers can either use pre-packaged generated bundles (e.g. [ydk-py](http://cs.co/ydk-py)),
Developers can either use pre-packaged generated bundles,
or define their own bundle, consisting of a set of YANG models, using a bundle profile
(e.g. [`ietf_0_1_5.json`](profiles/bundles/ietf_0_1_5.json)).
This gives the developer an ability to customize scope of their bundle based on their requirements.
Expand Down Expand Up @@ -340,13 +340,7 @@ optional arguments:

The below steps specify how to use `generate.py` to generate YDK core, model bundle, and service packages.
In all the examples the script is executed from `ydk-gen` directory.
It is assumed that Python virtual environment is activated.
All the packages are available for Python, Go and C++ in corresponding github repositories:
[ydk-py](https://github.com/CiscoDevNet/ydk-py), [ydk-go](https://github.com/CiscoDevNet/ydk-go)
and [ydk-cpp](https://github.com/CiscoDevNet/ydk-cpp).

The script [create_ydk_sdk_for_github.sh](create_ydk_sdk_for_github.sh) can be used to generate the `ydk-py`,
`ydk-cpp` and `ydk-go` repositories after having generated all the bundles and core packages using `generate.py`.
It is assumed that Python virtual environment is activated.

## Build model bundle profile

Expand Down Expand Up @@ -460,8 +454,7 @@ python3 generate.py --cpp --bundle profiles/bundles/<name-of-profile>.json -is
Now, you can start creating apps based on the models in your bundle.
Assuming you have generated a python bundle, the models will be available for importing in your app under
`ydk.models.<name-of-your-bundle>`.
For examples, see [ydk-py-samples](https://github.com/CiscoDevNet/ydk-py-samples#a-hello-world-app) and
[C++ samples](sdk/cpp/samples).
For examples, see [C++ samples](sdk/cpp/samples).
Also refer to the [documentation for python](http://ydk.cisco.com/py/docs/developer_guide.html),
[Go](http://ydk.cisco.com/go/docs/developer_guide.html) and
[C++](http://ydk.cisco.com/cpp/docs/developer_guide.html).
Expand Down Expand Up @@ -493,7 +486,7 @@ python3 generate.py --python --bundle profiles/bundles/cisco_ios_xr_6_6_3.json
python3 generate.py --python --core --generate-doc --output-directory gen-api --cached-output-dir
```

## Generating an "Adhoc" YDK-Py Bundle
## Generating an "Adhoc" Bundle

When YANG models available on the hard drive, there is capability to generate small model bundles, which include
just few models. It is called an "adhoc" bundle. Such a bundle generated without profile directly from command line.
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_6_2.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_7_1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE 16.7.1 models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_8_1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_8_1_post1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_9_1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xe_16_9_3.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XE models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XE YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XE models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xr-701.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "YDK Solutions",
"copyright": "YDK Solutions",
"description": "YDK bundle for Cisco IOS XR 7.0.1 models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xr-702.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "YDK Solutions",
"copyright": "YDK Solutions",
"description": "YDK bundle for Cisco IOS XR 7.0.2 models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xr_6_3_1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XR models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xr_6_3_2.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XR models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
2 changes: 1 addition & 1 deletion profiles/bundles/cisco-ios-xr_6_4_1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": "Cisco",
"copyright": "Cisco",
"description": "YDK bundle for Cisco IOS XR models",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles. You can find the SDK documentation at http://ydk.cisco.com/py/docs You can find more details on YDK at http://ydk.io",
"long_description": "This YANG Development Kit (YDK) bundle provides APIs for Cisco IOS XR YANG models. YDK facilitates the use 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. This YDK bundle for Cisco IOS XR models uses the YDK core package and additional model bundles.",
"models": {
"description": "Each element on the list has details on git repositories to source models from, including commit ids and relative paths inside the repositories. If no commit id is specified, HEAD is taken. This is unwise. The nested dir and file references are interpreted the same way as specific dir and file references above.",
"git": [
Expand Down
Loading

0 comments on commit 67ec6ae

Please sign in to comment.