From e1f7bb97441ebd8fbab5cfd434700094083a2e4a Mon Sep 17 00:00:00 2001 From: steveoh Date: Tue, 27 Jun 2023 11:55:53 -0600 Subject: [PATCH] docs: update readme's --- README.md | 6 ++---- src/readme.md | 3 +++ 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d1e3468..a5bb34e 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ A porter is person that - carries things, such as bags - performs routine cleaning, likely on a train, taking care of the sleeping berths. -AGRC tracks the additions, replacements, and deletions of SGID items (in the broadest sense of add, replace, or delete) through issues in this repository. +UGRC tracks the additions, replacements, and deletions of SGID items (in the broadest sense of add, replace, or delete) through issues in this repository. ## How to use -1. [Create a new issue](https://github.com/agrc/cemetery/issues/new/choose) when an application, dataset, or both needs to be added, deleted, or moved to a different long-term storage +1. [Create a new issue](https://github.com/agrc/porter/issues/new/choose) when an application, dataset, or both needs to be added, deleted, or moved to a different long-term storage 1. Choose the `Removing Data From Anywhere` (for moving or deleting data) or `Introduce data to the SGID` (for adding data) template from the buttons 1. Tag the three triagers (one from each team) in the triage section: - [ ] Data Team Triage (@gregbunce) @@ -25,8 +25,6 @@ AGRC tracks the additions, replacements, and deletions of SGID items (in the bro ## Data Flow for New SGID Datasets -Data in the internal SGID will automatically be added to the SGID10 with via the swapper pallet. - If there is a record added to `SGID.META.AGOLItems`, the corresponding dataset will automatically be added to: 1. the open sgid with cloudb diff --git a/src/readme.md b/src/readme.md index d951609..5dee83c 100644 --- a/src/readme.md +++ b/src/readme.md @@ -108,6 +108,9 @@ docker push gcr.io/ut-dts-agrc-porter-prod/conductor ## Development +1. create new python environment: `python -m venv venv` +1. activate new environment: `source venv/bin/activate` (On Windows: `.env\Scripts\activate`) +1. install dependencies and editable project: `pip install -e ".[tests]"` 1. use `test_conductor` as the entry point 1. install the Microsoft ODBC driver for SQL Server for [Windows](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server) or [macOS](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/install-microsoft-odbc-driver-sql-server-macos) 1. create a copy of `src/conductor/connections_sample.py` as `src/conductor/connections.py`