Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update vrs-python and vrs version correspondences #324

Merged
merged 7 commits into from
Jan 15, 2024
Merged

docs: update vrs-python and vrs version correspondences #324

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eba5f54
docs: change order in readme (#294)
sivangbagri Dec 20, 2023
89a08af
Enhanced installation guide (#306)
manish0kuniyal Jan 7, 2024
ef5ce41
docs: clean up postgresql readme
korikuzma Jan 9, 2024
2c68560
docs: change wording
korikuzma Jan 9, 2024
0e7de25
docs: update vrs-python and vrs version correspondences
korikuzma Jan 9, 2024
e6fba6c
Merge branch '2.x' into docs-postgresql
korikuzma Jan 9, 2024
a9d0a48
Merge branch 'docs-postgresql' into issue-292
korikuzma Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 43 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,29 @@ This repository contains several related components:
# VRS-Python and VRS Version Correspondence

The ga4gh/vrs-python repo embeds the ga4gh/vrs repo as a git submodule, and
therefore each ga4gh.vrs package on PyPi embeds a particular version of VRS. The
correspondences between the packages may be summarized as:
therefore each ga4gh.vrs package on PyPI embeds a particular version of VRS. The
correspondences between the packages that are **currently maintained** may be summarized as:

| vrs-python branch | vrs branch |
| ----------------------------------------------------- | ------------------------------------------------------------------------ |
| [main](https://github.com/ga4gh/vrs-python/tree/main) | [main](https://github.com/ga4gh/vrs/tree/main) |
| [0.6](https://github.com/ga4gh/vrs-python/tree/0.6) | [1.1](https://github.com/ga4gh/vrs/tree/1.1) |
| [0.7](https://github.com/ga4gh/vrs-python/tree/0.7) | [1.2](https://github.com/ga4gh/vrs/tree/1.2) |
| [0.8](https://github.com/ga4gh/vrs-python/tree/0.8) | [1.3](https://github.com/ga4gh/vrs/tree/1.3) |
| [0.9](https://github.com/ga4gh/vrs-python/tree/0.9) | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) |
| vrs-python branch | vrs-python tag/version | vrs branch | vrs version |
| --- | --- | --- | --- |
| [2.x](https://github.com/ga4gh/vrs-python/tree/2.x) _(default branch)_ | 2.x | [2.x](https://github.com/ga4gh/vrs/tree/2.x) | 2.x
| [1.x](https://github.com/ga4gh/vrs-python/tree/1.x) | 0.8.x | [1.x](https://github.com/ga4gh/vrs/tree/1.x) | 1.x |

⚠ **Note: Only 2.x branch is being actively maintained. The 1.x branch will only be maintained for bug fixes.**

⚠ **Developers: See the development section below for recommendations for using submodules
gracefully (and without causing problems for others!).**

## Previous VRS-Python and VRS Version Correspondence

The correspondences between the packages that are **no longer maintained** may be summarized as:

| vrs-python branch | vrs-python tag/version | vrs branch | vrs version |
| --- | --- | --- | --- |
| [0.6](https://github.com/ga4gh/vrs-python/tree/0.6) | 0.6.x | [1.1](https://github.com/ga4gh/vrs/tree/1.1) | 1.1.x |
| [0.7](https://github.com/ga4gh/vrs-python/tree/0.7) | 0.7.x | [1.2](https://github.com/ga4gh/vrs/tree/1.2) | 1.2.x |
| [0.9](https://github.com/ga4gh/vrs-python/tree/0.9) | 0.9.x | [metaschema-update](https://github.com/ga4gh/vrs/tree/metaschema-update) | N/A |

# Pre-requisite

[Python 3.10](https://www.python.org/downloads/release/python-3100/)
Expand Down Expand Up @@ -92,7 +101,31 @@ location.

# Installation

## Installing with pip
## Install PostgreSQL

PostgreSQL is required for UTA. Ensure that PostgreSQL is installed on your system. You can download and install PostgreSQL from [here](https://www.postgresql.org/download/) or [install using Homebrew](#install-postgresql-using-homebrew).

There are [macOS docs](https://github.com/ga4gh/vrs-python/tree/2.x/docs/setup_help) for additional assistance.

### Install PostgreSQL using Homebrew

1. Install Homebrew: See the [documentation](https://docs.brew.sh/Installation) for how to install.

1. Update Homebrew: Make sure Homebrew is up-to-date by running:

brew update

1. Install PostgreSQL: Use the following command to install [PostgreSQL](https://formulae.brew.sh/formula/postgresql@14#default):

brew install postgresql@14

1. Start PostgreSQL: Once the installation is complete, you can start the PostgreSQL service using:

brew services start postgresql

## Installing the VRS-Python package with pip

Once PostgreSQL is installed, proceed with the following command to install the VRS-Python package:

pip install 'ga4gh.vrs[extras]'

Expand Down
Loading