.. figure:: https://raw.githubusercontent.com/galaxyproject/gravity/main/docs/gravity-logo.png :alt: Gravity Logo :align: center :figwidth: 100% :target: https://github.com/galaxyproject/gravity
Process management for Galaxy_ servers.
.. image:: https://readthedocs.org/projects/gravity/badge/?version=latest :target: http://gravity.readthedocs.io/en/latest/ :alt: Documentation Status
.. image:: https://badge.fury.io/py/gravity.svg :target: https://pypi.python.org/pypi/gravity/ :alt: Gravity on the Python Package Index (PyPI)
.. image:: https://github.com/galaxyproject/gravity/actions/workflows/test.yaml/badge.svg :target: https://github.com/galaxyproject/gravity/actions/workflows/test.yaml
Modern Galaxy servers run multiple disparate processes: gunicorn_ for serving the web application, celery_ for
asynchronous tasks, tusd_ for fault-tolerant uploads, standalone Galaxy processes for job handling, and more. Gravity
is Galaxy's process manager, to make configuring and running these services simple.
Installing Gravity will give you two executables, galaxyctl which is used to manage the starting, stopping, and
logging of Galaxy's various processes, and galaxy, which can be used to run a Galaxy server in the foreground.
Python 3.7 or later is required. Gravity can be installed independently of Galaxy, but it is also a dependency of Galaxy since Galaxy 22.01. If you've installed Galaxy, then Gravity is already installed in Galaxy's virtualenv.
To install independently:
.. code:: console
$ pip install gravity
From the root directory of a source checkout of Galaxy, after first run (or running Galaxy's
./scripts/common_startup.sh), activate Galaxy's virtualenv, which will put Gravity's galaxyctl and galaxy
commands on your $PATH:
.. code:: console
$ . ./.venv/bin/activate
$ galaxyctl --help
Usage: galaxyctl [OPTIONS] COMMAND [ARGS]...
Manage Galaxy server configurations and processes.
... additional help output
You can start and run Galaxy in the foreground using the galaxy command:
.. code:: console
$ galaxy
Registered galaxy config: /srv/galaxy/config/galaxy.yml
Creating or updating service gunicorn
Creating or updating service celery
Creating or updating service celery-beat
celery: added process group
2022-01-20 14:44:24,619 INFO spawned: 'celery' with pid 291651
celery-beat: added process group
2022-01-20 14:44:24,620 INFO spawned: 'celery-beat' with pid 291652
gunicorn: added process group
2022-01-20 14:44:24,622 INFO spawned: 'gunicorn' with pid 291653
celery STARTING
celery-beat STARTING
gunicorn STARTING
==> /srv/galaxy/var/gravity/log/gunicorn.log <==
...log output follows...
Galaxy will continue to run and output logs to stdout until terminated with CTRL+C.
More detailed configuration and usage examples, especially those concerning production Galaxy servers, can be found in
the full documentation_.
.. _Galaxy: http://galaxyproject.org/ .. _gunicorn: https://gunicorn.org/ .. _celery: https://docs.celeryq.dev/ .. _tusd: https://tus.io/ .. _the full documentation: https://gravity.readthedocs.io
Version 1.0.0 represents a significant update to Gravity, its features and functionality. Although Gravity 1.x is intended to be backwards compatible with 0.x, you are strongly encouraged to read the documentation if upgrading to Gravity 1.x or to Galaxy 23.0 (which depends on Gravity 1.x) in order to get the most out of the new features.
galaxy entrypoint by @natefoo in https://github.com/galaxyproject/gravity/pull/87$VIRTUAL_ENV if virtualenv is set in config by @natefoo in https://github.com/galaxyproject/gravity/pull/97$PATH if virtualenv is set by @natefoo in https://github.com/galaxyproject/gravity/pull/98--preload by @Slugger70 in https://github.com/galaxyproject/gravity/pull/76--version option to get Gravity version by @natefoo in https://github.com/galaxyproject/gravity/pull/79processes in the handling dict in the job conf dict is a dict, not a list by @natefoo in https://github.com/galaxyproject/gravity/pull/60log_dir description by @nsoranzo in https://github.com/galaxyproject/gravity/pull/44start -f as its own subcommand. by @natefoo in https://github.com/galaxyproject/gravity/pull/16argparse_ to click_.planemo_ in general._) that won't be serialized. Also, it serializes itself and
can be created via deserialization from a classmethod. This simplifies using
it to persist state data in the new GravityState subclass... _argparse: https://docs.python.org/3/library/argparse.html .. _click: http://click.pocoo.org/ .. _planemo: https://github.com/galaxyproject/planemo
galaxycfg and galaxyadm commands to galaxy.supervisorctl
via the start, stop, and restart methods.galaxy start if it's called from the root (or
subdirectory) of a Galaxy root directory.galaxycfg remove accept instance names as params in addition to
config file paths.galaxyadmin to gravity (thanks John Chilton).galaxyadm subcommand graceful on a suggestion from Nicola
Soranzo.FAQs
Command-line utilities to assist in managing Galaxy servers
We found that gravity demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.