### 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` 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/84/ae/6296b707840d5745fcbbd0257c3c23d23cbce72aa023027a141609322f79/galaxy_importer-0.4.21.tar.gz",
"platform": null,
"description": "### 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` 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.21",
"project_urls": {
"Homepage": "https://github.com/ansible/galaxy-importer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "17df653e97c0f51d7a0dcc8c5a67709f0de8ca55208639dc83fafec379668f72",
"md5": "3da443587e52b9e0b52d512bb5aa7fbe",
"sha256": "8d227319e123bd6c83937a5a7718e19c2edf3d2e3f6bca9f93d3e4e76e5e80a6"
},
"downloads": -1,
"filename": "galaxy_importer-0.4.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3da443587e52b9e0b52d512bb5aa7fbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 60084,
"upload_time": "2024-04-04T15:38:54",
"upload_time_iso_8601": "2024-04-04T15:38:54.568444Z",
"url": "https://files.pythonhosted.org/packages/17/df/653e97c0f51d7a0dcc8c5a67709f0de8ca55208639dc83fafec379668f72/galaxy_importer-0.4.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84ae6296b707840d5745fcbbd0257c3c23d23cbce72aa023027a141609322f79",
"md5": "825ed1da55602e657e0da2177b9e7a20",
"sha256": "c1b3d7a23ac60422021d9413951e12e024808ac834d6e77c0ff3b197045b098a"
},
"downloads": -1,
"filename": "galaxy_importer-0.4.21.tar.gz",
"has_sig": false,
"md5_digest": "825ed1da55602e657e0da2177b9e7a20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43452,
"upload_time": "2024-04-04T15:38:56",
"upload_time_iso_8601": "2024-04-04T15:38:56.295934Z",
"url": "https://files.pythonhosted.org/packages/84/ae/6296b707840d5745fcbbd0257c3c23d23cbce72aa023027a141609322f79/galaxy_importer-0.4.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 15:38:56",
"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
