Galaxy content importer
Project description
Ansible Requirements
galaxy-importer requires the following other Ansible projects:
If you are installing from source, see setup.cfg in the repository for the matching requirements.
Install
From pypi
pip install galaxy-importer
From source
Clone repo and go into project directory
Install into environment the local setup.py including its development dependencies:
pip install -e .[dev]
Run importer
Run parsing/validation standalone to view log output and importer result for a build collection artifact file:
python -m galaxy_importer.main [collection_artifact_file]
Supports legacy roles (note: must be in the parent directory of the legacy role):
python -m galaxy_importer.main --legacy-role [legacy_role_directory] --namespace [namespace]
Supports converting markdown to html:
python -m galaxy_importer.main --markdown [readme_md_directory]
View log output in terminal, and view the importer result in the written file importer_result.json
Structure of Output
metadata(all data from MANIFEST.json, set by CollectionLoader._load_collection_manifest())docs_blob(set by CollectionLoader._build_docs_blob())collection_readmedocumentation_filescontentscontentsrequires_ansible
Configuration
An optional ini configuration file is supported, the following locations are checked in this order:
/etc/galaxy-importer/galaxy-importer.cfg
<code_source>/galaxy_importer/galaxy-importer.cfg
You can override the above paths by setting GALAXY_IMPORTER_CONFIG in the environment. For example:
$ export GALAXY_IMPORTER_CONFIG=~/galaxy-importer.cfg
Configuration options and their defaults are defined in DEFAULTS at galaxy_importer/config.py
Example configuration file with subset of config options:
[galaxy-importer]
LOG_LEVEL_MAIN = INFO
RUN_ANSIBLE_TEST = False
ANSIBLE_LOCAL_TMP = '~/.ansible/tmp'
-
ANSIBLE_LOCAL_TMP- Set to any desired local Ansible temp directory. Defaults to~/.ansible/tmp. -
ANSIBLE_TEST_LOCAL_IMAGE- Set toTrueto runansible-testsandboxed within a container image. Requires installation of either Podman or Docker to run the container. Defaults toFalse. -
CHECK_CHANGELOG- Set toFalseto not check for aCHANGELOG.rst orCHANGELOG.mdfile under the collection root ordocs/dir, or achangelogs/changelog.(yml/yaml)file. Defaults toTrue. -
CHECK_REQUIRED_TAGS- Set toTrueto check for a set of tags required for Ansible collection certification. Defaults toFalse. -
LOCAL_IMAGE_DOCKER- Set toTrueto run theansible-testcontainer image via Docker; otherwise, Podman will be used. Defaults toFalse. -
LOG_LEVEL_MAIN- Set to the desired log level. Defaults toINFO. -
OFFLINE_ANSIBLE_LINT- Set toFalseif you wantansible-lintto check for a new version. Defaults toTrue. -
REQUIRE_V1_OR_LATER- Set toTrueto require a version number1.0.0or greater. Defaults toFalse. -
RUN_ANSIBLE_DOC- Set toFalseto skipansible-doc. Defaults toTrue. -
RUN_ANSIBLE_LINT- Set toFalseto skip runningansible-lint --profile productionover the whole collection. Defaults toTrue. -
RUN_ANSIBLE_TEST- Set toTrueto runansible-testduring collection import. Defaults toFalse. -
RUN_FLAKE8- Set toTrueto run flake8. Defaults toFalse.
Issues and Process
To file an issue, visit the Automation Hub Jira project
Process details for galaxy-importer: PROCESS.md
Additional Notes
Place .md files in the docs/ dir to have them show up in an imported collection's "Documentation" tab on Galaxy or Automation Hub.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file galaxy_importer-0.4.24.tar.gz.
File metadata
- Download URL: galaxy_importer-0.4.24.tar.gz
- Upload date:
- Size: 43.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 392595d1d2647e0a2c5840e25d2bb8db76f94149900506b6acee2ffe990a364f |
|
| MD5 | 9389a90e4efbeb7271a4c125d85f8324 |
|
| BLAKE2b-256 | ee35092f671d76539785e5e7bd70756eb7384cdd6b6f223cea3129e0e0f55386 |
File details
Details for the file galaxy_importer-0.4.24-py3-none-any.whl.
File metadata
- Download URL: galaxy_importer-0.4.24-py3-none-any.whl
- Upload date:
- Size: 60.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 14a2958c4042a5017852e253fae1e0eefdef93d9ce0a84b6b2772299f6cd8e42 |
|
| MD5 | 3d060b25ce113035f4432c993d4a8396 |
|
| BLAKE2b-256 | f1ad472bdc27c5f0c7bde03db0563eb39e3e9b3e7daa078f98d5e57e3bffa69c |
