python_moondb rename

Change-Id: I6442b6f96393b4fcba8a6352ecb4ad845e6346c0
Signed-off-by: RHE <rebirthmonkey@gmail.com>

1 files changed, 32 insertions, 0 deletions

diff --git a/moonv4/python_moondb/README.md b/moonv4/python_moondb/README.md
new file mode 100644
index 00000000..d36c6ae3
--- /dev/null
+++ b/moonv4/python_moondb/README.md
@@ -0,0 +1,32 @@
+# python_moondb
+
+This package contains the database module for the Moon project
+It is designed to provide a driver to access the Moon database.
+
+For any other information, refer to the parent project:
+
+    https://git.opnfv.org/moon
+
+## Build
+### Build Python Package
+```bash
+cd ${MOON_HOME}/python_moondb
+python3 setup.py sdist bdist_wheel
+```
+
+### Push Python Package to PIP
+```bash
+cd ${MOON_HOME}/python_moondb
+gpg --detach-sign -u "${GPG_ID}" -a dist/python_moondb-X.Y.Z-py3-none-any.whl
+gpg --detach-sign -u "${GPG_ID}" -a dist/python_moondb-X.Y.Z.tar.gz
+twine upload dist/python_moondb-X.Y.Z-py3-none-any.whl dist/python_moondb-X.Y.Z-py3-none-any.whl.asc
+twine upload dist/python_moondb-X.Y.Z.tar.gz dist/python_moondb-X.Y.Z.tar.gz.asc
+```
+
+## Test
+### Python Unit Test
+launch Docker for Python unit tests
+```bash
+cd ${MOON_HOME}/python_moondb
+docker run --rm --volume $(pwd):/data wukongsun/moon_python_unit_test:latest
+```
\ No newline at end of file