### Ansible Requirements
``galaxy-importer`` requires the following other Ansible projects:
* ``ansible-lint`` up to [24.9.0](https://github.com/ansible/ansible-lint/tree/v24.9.0/docs)
* ``ansible-core`` up to [2.16](https://docs.ansible.com/ansible-core/2.16/index.html)
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`
* `contents`
* `requires_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](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`.
### Issues and Process
To file an issue, visit the [Automation Hub Jira project](https://issues.redhat.com/projects/AAH/issues)
Process details for `galaxy-importer`: [PROCESS.md](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.
Raw data
{
"_id": null,
"home_page": "https://github.com/ansible/galaxy-importer",
"name": "galaxy-importer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Red Hat, Inc.",
"author_email": "info@ansible.com",
"download_url": "https://files.pythonhosted.org/packages/39/9a/733ff6f75f1f097452c6bc4b40df58eed141738f1503cec46f3ad3ebeab6/galaxy_importer-0.4.26.tar.gz",
"platform": null,
"description": "### Ansible Requirements\n\n``galaxy-importer`` requires the following other Ansible projects:\n\n* ``ansible-lint`` up to [24.9.0](https://github.com/ansible/ansible-lint/tree/v24.9.0/docs)\n* ``ansible-core`` up to [2.16](https://docs.ansible.com/ansible-core/2.16/index.html)\n\nIf you are installing from source, see ``setup.cfg`` in the repository for the matching requirements.\n\n### Install\n\n#### From pypi\n\n`pip install galaxy-importer`\n\n#### From source\n\nClone repo and go into project directory\n\nInstall into environment the local setup.py including its development dependencies:\n\n`pip install -e .[dev]`\n\n### Run importer\n\nRun parsing/validation standalone to view log output and importer result for a build collection artifact file:\n\n`python -m galaxy_importer.main [collection_artifact_file]`\n\nSupports legacy roles (note: must be in the parent directory of the legacy role):\n\n`python -m galaxy_importer.main --legacy-role [legacy_role_directory] --namespace [namespace]`\n\nSupports converting markdown to html:\n\n`python -m galaxy_importer.main --markdown [readme_md_directory]`\n\nView log output in terminal, and view the importer result in the written file `importer_result.json`\n\n#### Structure of Output\n\n* `metadata` (all data from MANIFEST.json, set by CollectionLoader.\\_load_collection_manifest())\n* `docs_blob` (set by CollectionLoader.\\_build_docs_blob())\n * `collection_readme`\n * `documentation_files`\n * `contents`\n* `contents`\n* `requires_ansible`\n\n\n### Configuration\n\nAn optional ini configuration file is supported, the following locations are checked in this order:\n\n```\n/etc/galaxy-importer/galaxy-importer.cfg\n<code_source>/galaxy_importer/galaxy-importer.cfg\n```\n\nYou can override the above paths by setting `GALAXY_IMPORTER_CONFIG` in the environment. For example:\n\n```\n$ export GALAXY_IMPORTER_CONFIG=~/galaxy-importer.cfg\n```\n\nConfiguration options and their defaults are defined in `DEFAULTS` at [galaxy_importer/config.py](galaxy_importer/config.py)\n\nExample configuration file with subset of config options:\n\n```\n[galaxy-importer]\nLOG_LEVEL_MAIN = INFO\nRUN_ANSIBLE_TEST = False\nANSIBLE_LOCAL_TMP = '~/.ansible/tmp'\n```\n\n- `ANSIBLE_LOCAL_TMP` - Set to any desired local Ansible temp directory. Defaults to `~/.ansible/tmp`.\n\n- `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`.\n\n- `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`. \n\n- `CHECK_REQUIRED_TAGS` - Set to `True` to check for a set of tags required for Ansible collection certification. Defaults to `False`. \n\n- `LOCAL_IMAGE_DOCKER` - Set to `True` to run the `ansible-test` container image via Docker; otherwise, Podman will be used. Defaults to `False`.\n\n- `LOG_LEVEL_MAIN` - Set to the desired log level. Defaults to `INFO`. \n\n- `OFFLINE_ANSIBLE_LINT` - Set to `False` if you want `ansible-lint` to check for a new version. Defaults to `True`.\n\n- `REQUIRE_V1_OR_LATER` - Set to `True` to require a version number `1.0.0` or greater. Defaults to `False`.\n\n- `RUN_ANSIBLE_DOC` - Set to `False` to skip `ansible-doc`. Defaults to `True`.\n\n- `RUN_ANSIBLE_LINT` - Set to `False` to skip running `ansible-lint --profile production` over the whole collection. Defaults to `True`. \n\n- `RUN_ANSIBLE_TEST` - Set to `True` to run `ansible-test` during collection import. Defaults to `False`.\n\n- `RUN_FLAKE8` - Set to `True` to run flake8. Defaults to `False`. \n\n\n### Issues and Process\n\nTo file an issue, visit the [Automation Hub Jira project](https://issues.redhat.com/projects/AAH/issues)\n\nProcess details for `galaxy-importer`: [PROCESS.md](PROCESS.md)\n\n\n### Additional Notes\n\nPlace `.md` files in the `docs/` dir to have them show up in an imported collection's \"Documentation\" tab on Galaxy or Automation Hub. \n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Galaxy content importer",
"version": "0.4.26",
"project_urls": {
"Homepage": "https://github.com/ansible/galaxy-importer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "327f4809aaa73eeb5294b4fe5fb45e22212e8a7e46573cfca3ecd65a9b8c9225",
"md5": "1add43c9e3983d9db55d253333f387b1",
"sha256": "c1a5b6ab540da0056489fcbe388beb21e1b37b2abcbeb1c1d7fc07bc94cc013a"
},
"downloads": -1,
"filename": "galaxy_importer-0.4.26-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1add43c9e3983d9db55d253333f387b1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 60534,
"upload_time": "2024-10-23T18:32:29",
"upload_time_iso_8601": "2024-10-23T18:32:29.195650Z",
"url": "https://files.pythonhosted.org/packages/32/7f/4809aaa73eeb5294b4fe5fb45e22212e8a7e46573cfca3ecd65a9b8c9225/galaxy_importer-0.4.26-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "399a733ff6f75f1f097452c6bc4b40df58eed141738f1503cec46f3ad3ebeab6",
"md5": "efcbe6d92db5bfbb298d4af7bf6fd834",
"sha256": "0e31a071b10b7d33db4485a9723c0bafd1c606038ae5db49e8d78746384bb71f"
},
"downloads": -1,
"filename": "galaxy_importer-0.4.26.tar.gz",
"has_sig": false,
"md5_digest": "efcbe6d92db5bfbb298d4af7bf6fd834",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44035,
"upload_time": "2024-10-23T18:32:32",
"upload_time_iso_8601": "2024-10-23T18:32:32.476719Z",
"url": "https://files.pythonhosted.org/packages/39/9a/733ff6f75f1f097452c6bc4b40df58eed141738f1503cec46f3ad3ebeab6/galaxy_importer-0.4.26.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 18:32:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansible",
"github_project": "galaxy-importer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "galaxy-importer"
}
JSON
