Skip to content

Commit f954d66

Browse files
committed
🔧 (workflows): update poetry install command to include all extras
📝 (README.md): add installation instructions for PostgreSQL support ⬆️ (pyproject.toml): bump version to 0.2.2 and make psycopg optional with extras
1 parent 7d7bc94 commit f954d66

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

.github/workflows/coverage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
path: ./.venv
3838
key: venv-${{ hashFiles('poetry.lock') }}
3939
- name: Install dependencies
40-
run: poetry install
40+
run: poetry install --all-extras
4141
- name: Run tests and collect coverage
4242
run: poetry run pytest --cov=sqlift --cov-report=xml
4343
- name: Upload coverage raports to Codecov

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ jobs:
3939
path: ./.venv
4040
key: venv-${{ hashFiles('poetry.lock') }}
4141
- name: Install dependencies
42-
run: poetry install
42+
run: poetry install --all-extras
4343
- name: Run tests
4444
run: poetry run pytest

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,19 @@ SQLift is a simple CLI migration tool for SQL databases. It is designed to be ea
1818

1919
## Installation
2020

21+
You can install SQLift using pip:
22+
2123
```bash
2224
pip install SQLift
2325
```
2426

27+
By default, SQLift uses [SQLite](https://www.sqlite.org) as the database. If you want to use [PostgreSQL](https://www.postgresql.org), you need to install the appropriate database driver.
28+
You can do this using the following command:
29+
30+
```bash
31+
pip install SQLift[postgres]
32+
```
33+
2534
## Usage
2635

2736
First you need to create a 'migrations' directory where you will store your migration files.

pyproject.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "SQLift"
3-
version = "0.2.1"
3+
version = "0.2.2"
44
description = "Simple CLI migration tool for SQL databases"
55
license = "MIT"
66
authors = ["SpaceShaman <spaceshaman@tuta.io>"]
@@ -15,8 +15,11 @@ classifiers = [
1515

1616
[tool.poetry.dependencies]
1717
python = ">=3.10,<4"
18-
psycopg = {extras = ["binary"], version = "^3"}
1918
typer = "^0.15"
19+
psycopg = {extras = ["binary"], version = "^3", optional = true}
20+
21+
[tool.poetry.extras]
22+
postgres = ["psycopg"]
2023

2124
[tool.poetry.group.dev.dependencies]
2225
pytest = "^8"

0 commit comments

Comments
 (0)