From b6c210ee97d32fe0500cb3054a50dbc7716416b1 Mon Sep 17 00:00:00 2001 From: Ryan Petrello Date: Tue, 23 Jun 2020 17:38:29 -0400 Subject: [PATCH] update instructions and metadata for awxkit/cli installs --- INSTALL.md | 8 +++----- awxkit/setup.py | 19 ++++++++++++++++++- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index f790bc03ba..a6aede56c6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -651,16 +651,14 @@ Potential uses include: * Checking on the status and output of job runs * Managing objects like organizations, users, teams, etc... -The preferred way to install the AWX CLI is through pip directly from GitHub: +The preferred way to install the AWX CLI is through pip directly from PyPI: - pip install "https://github.com/ansible/awx/archive/$VERSION.tar.gz#egg=awxkit&subdirectory=awxkit" + pip3 install awxkit awx --help -...where ``$VERSION`` is the version of AWX you're running. To see a list of all available releases, visit: https://github.com/ansible/awx/releases - ## Building the CLI Documentation -To build the docs, spin up a real AWX server, `pip install sphinx sphinxcontrib-autoprogram`, and run: +To build the docs, spin up a real AWX server, `pip3 install sphinx sphinxcontrib-autoprogram`, and run: ~ TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html ~ cd build/html/ && python -m http.server diff --git a/awxkit/setup.py b/awxkit/setup.py index 7dac7a7b8e..6e357a800f 100644 --- a/awxkit/setup.py +++ b/awxkit/setup.py @@ -54,7 +54,10 @@ class CleanCommand(Command): setup( name='awxkit', version=get_version(), - description='awx cli client', + description='The official command line interface for Ansible AWX', + author='Red Hat, Inc.', + author_email='info@ansible.com', + url='https://github.com/ansible/awx', packages=find_packages(exclude=['test']), cmdclass={ 'clean': CleanCommand, @@ -70,6 +73,20 @@ setup( 'websockets': ['websocket-client>0.54.0'], 'crypto': ['cryptography'] }, + license='Apache 2.0', + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Console', + 'Intended Audience :: Developers', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: Apache Software License', + 'Operating System :: MacOS :: MacOS X', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python', + 'Programming Language :: Python :: 3.6', + 'Topic :: System :: Software Distribution', + 'Topic :: System :: Systems Administration', + ], entry_points={ 'console_scripts': [ 'akit=awxkit.scripts.basic_session:load_interactive',