aboutsummaryrefslogtreecommitdiffstats
path: root/old/python_moonclient/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'old/python_moonclient/README.md')
-rw-r--r--old/python_moonclient/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/old/python_moonclient/README.md b/old/python_moonclient/README.md
new file mode 100644
index 00000000..1a9731e7
--- /dev/null
+++ b/old/python_moonclient/README.md
@@ -0,0 +1,33 @@
+# python-moonclient
+This package contains the core module for the Moon project.
+It is designed to provide authorization feature to all OpenStack components.
+
+For any other information, refer to the parent project:
+
+ https://git.opnfv.org/moon
+
+python_moonutilities is a common Python lib for other Moon Python packages
+
+## Build
+### Build Python Package
+```bash
+cd ${MOON_HOME}/python_moonclient
+python3 setup.py sdist bdist_wheel
+```
+
+### Push Python Package to PIP
+```bash
+cd ${MOON_HOME}/python_moonclient
+gpg --detach-sign -u "${GPG_ID}" -a dist/python_moonclient-X.Y.Z-py3-none-any.whl
+gpg --detach-sign -u "${GPG_ID}" -a dist/python_moonclient-X.Y.Z.tar.gz
+twine upload dist/python_moonclient-X.Y.Z-py3-none-any.whl dist/python_moonclient-X.Y.Z-py3-none-any.whl.asc
+twine upload dist/python_moonclient-X.Y.Z.tar.gz dist/python_moonclient-X.Y.Z.tar.gz.asc
+```
+
+## Test
+### Python Unit Test
+launch Docker for Python unit tests
+```bash
+cd ${MOON_HOME}/python_moonclient
+docker run --rm --volume $(pwd):/data wukongsun/moon_python_unit_test:latest
+```