1
0
mirror of https://github.com/ansible/awx.git synced 2024-10-27 00:55:06 +03:00

update instructions and metadata for awxkit/cli installs

This commit is contained in:
Ryan Petrello 2020-06-23 17:38:29 -04:00
parent 69589821ce
commit b6c210ee97
No known key found for this signature in database
GPG Key ID: F2AA5F2122351777
2 changed files with 21 additions and 6 deletions

View File

@ -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

View File

@ -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',