Repository: stratos Updated Branches: refs/heads/stratos-4.1.x 35cadf67c -> c1c06ecc4
Fixing STRATOS-1599: Python CLI instructions Project: http://git-wip-us.apache.org/repos/asf/stratos/repo Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/c1c06ecc Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/c1c06ecc Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/c1c06ecc Branch: refs/heads/stratos-4.1.x Commit: c1c06ecc40250c48746a3984037d84299704eefe Parents: 35cadf6 Author: Akila Perera <[email protected]> Authored: Fri Nov 6 22:40:25 2015 +0530 Committer: Akila Perera <[email protected]> Committed: Fri Nov 6 22:40:25 2015 +0530 ---------------------------------------------------------------------- .../src/main/python/README.rst | 75 -------------------- .../src/main/python/setup.py | 3 +- .../distribution/src/main/assembly/bin.xml | 21 +++++- .../modules/distribution/src/main/notice/NOTICE | 4 +- .../modules/distribution/src/main/readme/README | 25 ------- 5 files changed, 22 insertions(+), 106 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/stratos/blob/c1c06ecc/components/org.apache.stratos.python.cli/src/main/python/README.rst ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.python.cli/src/main/python/README.rst b/components/org.apache.stratos.python.cli/src/main/python/README.rst deleted file mode 100644 index b342790..0000000 --- a/components/org.apache.stratos.python.cli/src/main/python/README.rst +++ /dev/null @@ -1,75 +0,0 @@ -================================================================================ - Apache Stratos CLI -================================================================================ - -Welcome to the Apache Stratos CLI. - -The command line interface (CLI) is a powerful tool that clients can use -to communicate with Stratos services. The CLI distribution only includes one -jar file containing all dependent java libraries. - -The tenant can use the CLI tool on two separate modes if needed, which -are namely single command line mode and interactive mode. - -If the user executes with a command as an argument, the CLI tool -will execute that command and exit with a status code. - -However, if there is no command as an argument, the CLI tool will -enter into an interactive mode. - -A user will be able to carryout all the following functions via the -CLI, with the exception of registering tenants and viewing logs. - -The CLI tool also supports command history and auto-completing features -in the interactive mode. - -Configuring CLI Tool -================================== -Configuration guide can be found at https://cwiki.apache.org/confluence/display/STRATOS/4.1.0+Configuring+CLI+Tool - -Help -================================== -usage: stratos [-debug] [-h] [-p <password>] [-trace] [-u <username>] - -debug Enable debug logging - -h,--help Display this help - -p,--password <password> Password - -trace Enable trace logging - -u,--username <username> Username - - -Available Commands: -create-tenant Add new tenant -list-autoscale-policies List available autoscale policies -subscribe-cartridge Subscribe to a cartridge -exit Exit from Stratos Client Tool -list-available-cartridges List available cartridges -help Help for commands -list-available-partitions List available partitions -deploy-cartridge Add new cartridge deployment -unsubscribe-cartridge Unsubscribe from a subscribed cartridge -list-subscribe-cartridges List subscribed cartridges with details -deploy-partition Add new partition deployment -deploy-autoscaling-policy Add new autoscaling policy deployment -deploy-deployment-policy Add new deployment policy - - -Support -================================== - -Any problem with this release can be reported to Apache Stratos mailing list -or in the JIRA issue tracker. If you are sending an email to the mailing -list make sure to add the [Apache Stratos] prefix to the subject. - -Mailing list subscription: - [email protected] - - -Issue Tracker -================================== - -Jira: - https://issues.apache.org/jira/browse/stratos - - -Thank you for using Apache Stratos! -The Stratos Team http://git-wip-us.apache.org/repos/asf/stratos/blob/c1c06ecc/components/org.apache.stratos.python.cli/src/main/python/setup.py ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.python.cli/src/main/python/setup.py b/components/org.apache.stratos.python.cli/src/main/python/setup.py index 9bb3c84..c5af548 100644 --- a/components/org.apache.stratos.python.cli/src/main/python/setup.py +++ b/components/org.apache.stratos.python.cli/src/main/python/setup.py @@ -26,7 +26,6 @@ def read(file_name): setup( name="stratos-cli", version="4.1.5", - version="4.1.5", author="Apache Stratos", author_email="[email protected]", description="CLI tool to interact with Apache Stratos", @@ -34,7 +33,7 @@ setup( url="http://stratos.apache.org/";, packages=['cli'], install_requires=['cmd2', 'requests', 'texttable'], - long_description=read('README.rst'), + long_description=read('README.md'), classifiers=[ "Development Status :: 1 - Planning", "Topic :: Utilities", http://git-wip-us.apache.org/repos/asf/stratos/blob/c1c06ecc/products/python-cli/modules/distribution/src/main/assembly/bin.xml ---------------------------------------------------------------------- diff --git a/products/python-cli/modules/distribution/src/main/assembly/bin.xml b/products/python-cli/modules/distribution/src/main/assembly/bin.xml index 5590d9f..ba1ae96 100644 --- a/products/python-cli/modules/distribution/src/main/assembly/bin.xml +++ b/products/python-cli/modules/distribution/src/main/assembly/bin.xml @@ -36,6 +36,21 @@ </excludes> <fileMode>0755</fileMode> </fileSet> + <fileSet> + <directory> + ${project.basedir}/../../../../components/org.apache.stratos.python.cli/src/main/python/ + </directory> + <outputDirectory>.</outputDirectory> + <includes> + <include>setup.cfg</include> + <include>setup.py</include> + <include>tox.ini</include> + </includes> + <excludes> + <exclude>**/*.pyc</exclude> + </excludes> + <fileMode>0755</fileMode> + </fileSet> </fileSets> <files> <file> @@ -51,10 +66,12 @@ <fileMode>644</fileMode> </file> <file> - <source>${project.basedir}/src/main/readme/README</source> + <source> + ${project.basedir}/../../../../components/org.apache.stratos.python.cli/src/main/python/README.md + </source> <outputDirectory>/</outputDirectory> <filtered>true</filtered> <fileMode>644</fileMode> </file> </files> -</assembly> \ No newline at end of file +</assembly> http://git-wip-us.apache.org/repos/asf/stratos/blob/c1c06ecc/products/python-cli/modules/distribution/src/main/notice/NOTICE ---------------------------------------------------------------------- diff --git a/products/python-cli/modules/distribution/src/main/notice/NOTICE b/products/python-cli/modules/distribution/src/main/notice/NOTICE index c59ffa6..bf65ea1 100644 --- a/products/python-cli/modules/distribution/src/main/notice/NOTICE +++ b/products/python-cli/modules/distribution/src/main/notice/NOTICE @@ -1,5 +1,5 @@ -Apache Stratos Python Cartridge Agent +Apache Stratos Python CLI Copyright 2015 The Apache Software Foundation This product includes software developed at -The Apache Software Foundation (http://www.apache.org/). \ No newline at end of file +The Apache Software Foundation (http://www.apache.org/). http://git-wip-us.apache.org/repos/asf/stratos/blob/c1c06ecc/products/python-cli/modules/distribution/src/main/readme/README ---------------------------------------------------------------------- diff --git a/products/python-cli/modules/distribution/src/main/readme/README b/products/python-cli/modules/distribution/src/main/readme/README deleted file mode 100644 index 8b734d1..0000000 --- a/products/python-cli/modules/distribution/src/main/readme/README +++ /dev/null @@ -1,25 +0,0 @@ -Apache Stratos CLI -================== - -Build and install stratos CLI by, - -``` -$ python setup.py build -$ python setup.py install -``` - -or use -``` - $ python setup.py develop -``` - -instead `install` if developing - -To start the Python CLI issue, - -``` -$ stratos -``` - - -
