aboutsummaryrefslogtreecommitdiffstats
path: root/moonv4/python_moonclient/README.md
diff options
context:
space:
mode:
authorRHE <rebirthmonkey@gmail.com>2017-12-21 10:06:52 +0100
committerThomas Duval <thomas.duval@orange.com>2017-12-21 10:33:15 +0100
commit8b326a5aeb0f9655ff0ebfe0d87ff1ea8f66bc38 (patch)
tree16f319475de8f256914e18a6be0183b48ccc692a /moonv4/python_moonclient/README.md
parenta7f99c33c0b2b2c617dd044e658a263ae910b53a (diff)
python_moonclient init
Change-Id: Iaf104b3208a07dc80cc266830be444d019b0f196 Signed-off-by: RHE <rebirthmonkey@gmail.com>
Diffstat (limited to 'moonv4/python_moonclient/README.md')
-rw-r--r--moonv4/python_moonclient/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/moonv4/python_moonclient/README.md b/moonv4/python_moonclient/README.md
new file mode 100644
index 00000000..d091cdf5
--- /dev/null
+++ b/moonv4/python_moonclient/README.md
@@ -0,0 +1,33 @@
+# python-moonclient Package
+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
+
+moon_utilities is a common Python lib for other Moon Python packages
+
+## Build
+### Build Python Package
+```bash
+cd ${MOON_HOME}/moonv4/python_moonclient
+python3 setup.py sdist bdist_wheel
+```
+
+### Push Python Package to PIP
+```bash
+cd ${MOON_HOME}/moonv4/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}/moonv4/python_moonclient
+docker run --rm --volume $(pwd):/data wukongsun/moon_python_unit_test:latest
+```