External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-02-17 03:00:04 -03:30
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7427 from ryanpetrello/awxkit-install

Browse Source 
update instructions and metadata for awxkit/cli installs

Reviewed-by: https://github.com/apps/softwarefactory-project-zuul
This commit is contained in:
softwarefactory-project-zuul[bot]
2020-06-23 22:23:56 +00:00
committed by GitHub
parent f4514873cd b6c210ee97
commit c1bbeadf8d
2 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
INSTALL.md
View File

@@ -651,16 +651,14 @@ Potential uses include:
* Checking on the status and output of job runs * Checking on the status and output of job runs
* Managing objects like organizations, users, teams, etc... * 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 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 ## 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 ~ TOWER_HOST=https://awx.example.org TOWER_USERNAME=example TOWER_PASSWORD=secret make clean html
~ cd build/html/ && python -m http.server ~ cd build/html/ && python -m http.server

19
awxkit/setup.py
View File

@@ -54,7 +54,10 @@ class CleanCommand(Command):
setup( setup(
name='awxkit', name='awxkit',
version=get_version(), 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']), packages=find_packages(exclude=['test']),
cmdclass={ cmdclass={
'clean': CleanCommand, 'clean': CleanCommand,
@@ -70,6 +73,20 @@ setup(
'websockets': ['websocket-client>0.54.0'], 'websockets': ['websocket-client>0.54.0'],
'crypto': ['cryptography'] '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={ entry_points={
'console_scripts': [ 'console_scripts': [
'akit=awxkit.scripts.basic_session:load_interactive', 'akit=awxkit.scripts.basic_session:load_interactive',