Overview
Module and script for bootstrapping Galaxy job config files.
Installation
Install from PyPI:
pip install galaxy-job-config-init
CLI Usage
The package provides two command-line tools:
galaxy-job-config-init
Generate job configuration YAML for Galaxy:
galaxy-job-config-init [OPTIONS]
Options:
--galaxy-version TEXT
Generate job config YAML for this version of Galaxy
--runner {local,slurm,pbs,condor,kubernetes}
Galaxy runner (e.g. DRM) to target (defaults to 'local')
--tpv
Enable shared TPV database
--docker
Enable Docker
--docker-cmd TEXT
Command used to launch docker (defaults to 'docker')
--docker-host TEXT
Docker host
--docker-sudo
Use sudo with Docker
--docker-sudo-cmd TEXT
Docker sudo command
--docker-run-extra-arguments TEXT
Extra arguments for Docker run
--docker-extra-volume TEXT
Extra Docker volumes (can be specified multiple times)
--singularity
Enable Singularity
--singularity-cmd TEXT
Command used to execute singularity (defaults to 'singularity')
--singularity-sudo
Use sudo with Singularity
--singularity-sudo-cmd TEXT
Singularity sudo command
--singularity-extra-volume TEXT
Extra Singularity volumes (can be specified multiple times)
--tmp-dir TEXT
Configure temporary directory handling (defaults to 'true')
--all-in-one-handling
Use all-in-one job handling configuration
galaxy-job-config-init-summary
Generate a summary of the job configuration. See job_config_examples.md for detailed examples of generated configurations.
Examples
Generate a basic local job configuration:
galaxy-job-config-init
Generate configuration for SLURM with Docker support:
galaxy-job-config-init --runner slurm --docker
Generate configuration with custom Docker volumes:
galaxy-job-config-init --docker --docker-extra-volume /data:/data --docker-extra-volume /scratch:/scratch
Generate configuration for all-in-one Galaxy instance:
galaxy-job-config-init --all-in-one-handling
Contributing
Contributions are welcome! Please see CONTRIBUTING.rst for development setup, code quality guidelines, and release procedures.
History
0.1.4
Expand readme
Add --local-workers option to specify LocalJobRunner workers
0.1.3
Enhanced tmp_dir configuration to support string values for custom temp directory allocation (environment variables and shell commands)
Added all-in-one-handling option for simplified Galaxy instances (removes separate handling section)
Added comprehensive development tooling: black, isort, ruff, mypy, and pre-commit hooks
Added GitHub Actions CI workflow with automated testing across Python 3.9-3.13
Added PyPI deployment workflow with trusted publishing
Added CONTRIBUTING.rst with detailed development guidelines
Updated README.rst with contributing information
Added comprehensive test coverage for new features
0.1.2
Add tmp_dir config option thanks to @Smeds. https://github.com/galaxyproject/galaxy-job-config-init/pull/1
0.1.1
Fix for StrEnum usage on older Python versions.
0.1.0
Initial creation with simple options for TPV, various DRMs, and container settings.
Metadata
Release files for galaxy-job-config-init 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| galaxy_job_config_init-0.1.4.tar.gz | 12.8 kB | With provenance | Details for galaxy_job_config_init-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| galaxy_job_config_init-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for galaxy_job_config_init-0.1.4-py3-none-any.whl |
Total release size: 25.9 kB
Release files / galaxy_job_config_init-0.1.4.tar.gz
| Download URL | galaxy_job_config_init-0.1.4.tar.gz |
|---|---|
| Size | 12.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ce631472ab968d12bd42042a6686aa61704cf7a5c44d1f896b2dd35ebc52ef42
|
|
BLAKE2b-256 checksum How to use checksums |
3918918f367d96222afc759d9abc979eecd6fa75b5cd266f9e3b60482c694008
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency logRelease files / galaxy_job_config_init-0.1.4-py3-none-any.whl
| Download URL | galaxy_job_config_init-0.1.4-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d9db27a0dee86da4adc22a35ec9a97b631a921d9a4eb9fba199cbfdc6cbaf35f
|
|
BLAKE2b-256 checksum How to use checksums |
927a8017d45e513c720ee82bf062b1be3ae39087db3024571b4a00773e17c235
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency logSecurity for galaxy-job-config-init 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for galaxy_job_config_init-0.1.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.