diff options
| author |   Lianhao Lu <lianhao.lu@intel.com> | 2018-03-22 20:39:04 +0800 |
|---|---|---|
| committer | Lianhao Lu <lianhao.lu@intel.com> | 2018-03-22 20:54:00 +0800 |
| commit | 7676ca5e12557f72226fac162e5f1530964906cb (patch) | |
| tree | 8659c0036c8dbbdeca02d186ec28f37b87fec401 /README.rst | |
| parent | c3fe9827d9357f5fa2a62f6f0965ad40106a5aad (diff) | |
Adjusted for pypi support
We need to adjust the python module structure meet the pypi
requirements. This has been tested on test pypi
https://test.pypi.org/project/vnfsdk.
1. move 3 directories cli/ validator/ packager/ into vnfsdk_pkgtools. so
now the python module for vnfsdk pkgtools would be "vnfsdk_pkgtool.*"
2. Added missing README.rst, LICENSE.txt according to pypi requirement.
3. Added new version mechanism accroding onap community suggestions.
4. Other clean sweep job like dos2unix.
Change-Id: If90df33673bff045d85d67c29a1d0ab44d0c8858
Issue-ID: VNFSDK-143
Signed-off-by: Lianhao Lu <lianhao.lu@intel.com>
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..cd13d63 --- /dev/null +++ b/README.rst @@ -0,0 +1,16 @@ +ONAP VNFSDK CSAR Package Tool +======================== +VNFSDK package tool provides VNF product DevOps engineers with the tools to manage the VNF package content. The tools are provided in a form of a shared library (Python module) that can be used in other projects. A CLI is also provided out-of-the box for DevOps to use the library with their scripts and automation framework. + +Source Code: https://git.onap.org/vnfsdk/pkgtools + +Usage +----- +- Create CSAR package + $ vnfsdk csar-create -d DESTINATION [–manifest MANIFEST] [–history HISTORY] [–tests TESTS] [–licenses LICENSES] source entry +- Extract CSAR package + $ vnfsdk csar-open -d DESTINATION source +- Validate CSAR package + $ vnfsdk csar-validate source + +All commands have -h switch which displays help and description of all parameters. |