galaxy-importer

Ansible Requirements

galaxy-importer requires the following other Ansible projects:

ansible-lint up to 26.10.1
ansible-core up to 2.16

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_readme
documentation_files
contents
requires_ansible
patterns

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 to True to run ansible-test sandboxed within a container image. Requires installation of either Podman or Docker to run the container. Defaults to False.
CHECK_CHANGELOG - Set to False to not check for a CHANGELOG.rst or CHANGELOG.md file under the collection root or docs/ dir, or a changelogs/changelog.(yml/yaml) file. Defaults to True.
CHECK_REQUIRED_TAGS - Set to True to check for a set of tags required for Ansible collection certification. Defaults to False.
LOCAL_IMAGE_DOCKER - Set to True to run the ansible-test container image via Docker; otherwise, Podman will be used. Defaults to False.
LOG_LEVEL_MAIN - Set to the desired log level. Defaults to INFO.
OFFLINE_ANSIBLE_LINT - Set to False if you want ansible-lint to check for a new version. Defaults to True.
REQUIRE_V1_OR_LATER - Set to True to require a version number 1.0.0 or greater. Defaults to False.
RUN_ANSIBLE_DOC - Set to False to skip ansible-doc. Defaults to True.
RUN_ANSIBLE_LINT - Set to False to skip running ansible-lint --profile production over the whole collection. Defaults to True.
RUN_ANSIBLE_TEST - Set to True to run ansible-test during collection import. Defaults to False.
RUN_FLAKE8 - Set to True to run flake8. Defaults to False.

Maintenance

galaxy-importer uses a list of SPDX licenses stored at galaxy_importer/utils/spdx_licenses.json. This file must be periodically updated to reflect the addition, removal, and deprecation of licenses in the future. Use scripts/update_spdx.py to update licenses: python scripts/update_spdx.py.

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.

License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
Programming Language
- Python :: 3

Metadata

License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
Programming Language
- Python :: 3

Release files for galaxy-importer 0.4.44

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for galaxy-importer 0.4.44
File	Size	Uploaded
galaxy_importer-0.4.44.tar.gz	49.7 kB	Oct 13, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for galaxy-importer 0.4.44
File	Interpreter	ABI	Platform	Reset
galaxy_importer-0.4.44-py3-none-any.whl 65.3 kB Oct 13, 2026	Python 3	none	any	Details

Total release size: 115.0 kB

Release files / galaxy_importer-0.4.44.tar.gz

Download URL	galaxy_importer-0.4.44.tar.gz
Size	49.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`6c024fed7689f854bc8131d613a677f5929e34b01e2c9d63ac63ec69ae37004c`
BLAKE2b-256 checksum How to use checksums	`081524ff85d10875a0a54c79f1754b6dab04d880252a4412942419bc2f2f4427`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / galaxy_importer-0.4.44-py3-none-any.whl

Download URL	galaxy_importer-0.4.44-py3-none-any.whl
Size	65.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c2261e6480cb71c445228233f2de906ef96fa5dc55b138a85e5e5a7c30902de7`
BLAKE2b-256 checksum How to use checksums	`641b4d44021b882562ecf0128989fcf8dae590f112aa6e6c5bd9f3a4a4d508f1`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`