Skip to content

Commit

Permalink
Made the project deployable with pip
Browse files Browse the repository at this point in the history
  • Loading branch information
mgcam committed Jul 23, 2024
1 parent ee42cca commit 5de1505
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ customers.
To register recently QC-ed entities as tasks with `porch`

```bash
qc_state_notification register --conf_file_path path/to/qc_state_app_config.ini
npg_qc_state_notification register --conf_file_path path/to/qc_state_app_config.ini
```

To process one `porch` task

```bash
qc_state_notification process --conf_file_path path/to/qc_state_app_config.ini
npg_qc_state_notification process --conf_file_path path/to/qc_state_app_config.ini
```

Processing includes claiming one task, sending per-study emails and updating the
status of the `porch` task to `DONE`.

The test data directory has an example of a [configuration file](tests/data/qc_state_app_config.ini).
The test data directory has an example of a [configuration file](tests/data/qc_state_app_config.ini).
12 changes: 8 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,30 @@
name = "npg_notify"
version = "0.0.1"
description = "Utility for client notifications"
authors = ["Marina Gourtovaia <[email protected]>"]
authors = ["Marina Gourtovaia"]
license = "GPL-3.0-or-later"
readme = "README.md"

[tool.poetry.scripts]
qc_state_notification = "npg_notify.porch_wrapper.qc_state:run"
npg_qc_state_notification = "npg_notify.porch_wrapper.qc_state:run"

[tool.poetry.dependencies]
python = "^3.11"
SQLAlchemy = { version="^2.0.1", extras=["pymysql"] }
SQLAlchemy-Utils = "^0.41.2"
cryptography = { version="^41.0.3" }
cryptography = "^41.0.3"
PyYAML = "^6.0.0"
npg_porch_cli = { git="https://github.com/wtsi-npg/npg_porch_cli.git", branch="devel" }

[tool.poetry.dev-dependencies]
pytest = "^8.2.2"
PyYAML = "^6.0.0"
requests-mock = "^1.12.1"
ruff = "^0.4.9"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.ruff]
# Set the maximum line length to 79.
line-length = 79
Expand Down

0 comments on commit 5de1505

Please sign in to comment.