nova-galaxy

Name	nova-galaxy JSON
Version	0.5.0 JSON
	download
home_page	None
Summary	Utilties for accessing the ORNL Galaxy instance
upload_time	2025-01-15 18:13:36
maintainer	None
docs_url	None
author	Greg Watson
requires_python	<4.0,>=3.10
license	MIT
keywords	nova galaxy python
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # nova-galaxy
=======================

# Introduction

This is the repository for the nova-galaxy project. This project creates a python package that makes it easier to work with the ORNL Galaxy instance.

## Documentation

A user guide, examples, and a full API for this package can be found at https://nova-galaxy.readthedocs.io/en/stable/.

## Installation
You can install this package directly with

```commandline
pip install nova-galaxy
```

or with Poetry by placing the following in your pyproject.toml file (you can version lock with typical Semantic Versioning syntax)


```
[tool.poetry.dependencies]
nova-galaxy = "*"
```

## Formatting
```commandline
poetry run ruff format
```

## Linting
```commandline
poetry run ruff check
poetry run mypy .
```

## Testing
You can run the tests for this package with the following command from the base directory:
```commandline
NOVA_GALAXY_TEST_GALAXY_URL=galaxy-url NOVA_GALAXY_TEST_GALAXY_KEY=key poetry run pytest tests/
```
with `NOVA_GALAXY_TEST_GALAXY_URL` being the url of your Galaxy instance and `NOVA_GALAXY_TEST_GALAXY_KEY` being your
Galaxy API Key.

To run tests with coverage (include the above environment variables):
```commandline
poetry run coverage run
poetry run coverage report
```

## CI/CD in GitLab

Take a look at the `.gitlab-ci.yml` file. It configures pipelines to run in [GitLab](https://code.ornl.gov/ndip/project-templates/python/-/pipelines).
Some jobs will run automatically on each commit, jobs to
build packages and Docker images need to be trigerred manually. Don't forget to set versions properly:
in `pyproject.toml` for python package and in `.gitlab-ci.yml` for Docker tag.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nova-galaxy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "NOVA, Galaxy, python",
    "author": "Greg Watson",
    "author_email": "watsongr@ornl.gov",
    "download_url": null,
    "platform": null,
    "description": "# nova-galaxy\n=======================\n\n# Introduction\n\nThis is the repository for the nova-galaxy project. This project creates a python package that makes it easier to work with the ORNL Galaxy instance.\n\n## Documentation\n\nA user guide, examples, and a full API for this package can be found at https://nova-galaxy.readthedocs.io/en/stable/.\n\n## Installation\nYou can install this package directly with\n\n```commandline\npip install nova-galaxy\n```\n\nor with Poetry by placing the following in your pyproject.toml file (you can version lock with typical Semantic Versioning syntax)\n\n\n```\n[tool.poetry.dependencies]\nnova-galaxy = \"*\"\n```\n\n## Formatting\n```commandline\npoetry run ruff format\n```\n\n## Linting\n```commandline\npoetry run ruff check\npoetry run mypy .\n```\n\n## Testing\nYou can run the tests for this package with the following command from the base directory:\n```commandline\nNOVA_GALAXY_TEST_GALAXY_URL=galaxy-url NOVA_GALAXY_TEST_GALAXY_KEY=key poetry run pytest tests/\n```\nwith `NOVA_GALAXY_TEST_GALAXY_URL` being the url of your Galaxy instance and `NOVA_GALAXY_TEST_GALAXY_KEY` being your\nGalaxy API Key.\n\nTo run tests with coverage (include the above environment variables):\n```commandline\npoetry run coverage run\npoetry run coverage report\n```\n\n## CI/CD in GitLab\n\nTake a look at the `.gitlab-ci.yml` file. It configures pipelines to run in [GitLab](https://code.ornl.gov/ndip/project-templates/python/-/pipelines).\nSome jobs will run automatically on each commit, jobs to\nbuild packages and Docker images need to be trigerred manually. Don't forget to set versions properly:\nin `pyproject.toml` for python package and in `.gitlab-ci.yml` for Docker tag.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Utilties for accessing the ORNL Galaxy instance",
    "version": "0.5.0",
    "project_urls": null,
    "split_keywords": [
        "nova",
        " galaxy",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "34fe1ccfbdd1cbe55cd2cac68833601e6fd72630fa49a654693d2e89dfea87d2",
                "md5": "b0ae8f9af7f7233cfe544fa8e648e524",
                "sha256": "6cea63f913dedc0bac58e40b3c6f0ce67f80c1f196818aad65de42eea27ec1b8"
            },
            "downloads": -1,
            "filename": "nova_galaxy-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b0ae8f9af7f7233cfe544fa8e648e524",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 11710,
            "upload_time": "2025-01-15T18:13:36",
            "upload_time_iso_8601": "2025-01-15T18:13:36.894665Z",
            "url": "https://files.pythonhosted.org/packages/34/fe/1ccfbdd1cbe55cd2cac68833601e6fd72630fa49a654693d2e89dfea87d2/nova_galaxy-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-15 18:13:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "nova-galaxy"
}