From cde2f4d6497178e8bfed6f6c573d5ae5ca33939b Mon Sep 17 00:00:00 2001 From: Yx Jiang <2237303+yxjiang@users.noreply.github.com> Date: Sun, 10 Mar 2024 22:26:38 -0700 Subject: [PATCH] update --- DEV_README.md | 20 +++++++++++++------- requirements.txt | 1 + 2 files changed, 14 insertions(+), 7 deletions(-) create mode 100644 requirements.txt diff --git a/DEV_README.md b/DEV_README.md index ec5aaff..7641153 100644 --- a/DEV_README.md +++ b/DEV_README.md @@ -1,17 +1,23 @@ # Local Development -## Configure Test Pypi -1. Add the Test PyPI Repository to Poetry: +## Configure Test PyPI for Poetry + +For publishing packages to Test PyPI using Poetry during development, it is recommended to use an environment variable for the Test PyPI token. This avoids issues with keychain access on macOS and is generally simpler for automation and scripting. + +### Setting Up Environment Variable for Test PyPI Token + +1. **Export the Test PyPI API Token**: + +Export your Test PyPI token as an environment variable in your terminal session before running the publish command. -You only need to do this once per machine. This step tells Poetry where the Test PyPI repository is located. ```bash -poetry config repositories.testpypi https://test.pypi.org/legacy/ +export POETRY_TEST_PYPI_API_TOKEN= ``` -2. Set the Test PyPI API Token: +2. **Run the local publish command**: -Replace with your actual Test PyPI token. This token is used for authentication when publishing packages to Test PyPI. +In the project root folder. ```bash -poetry config http-basic.testpypi __token__ +./tests/build_test_pypi.sh ``` \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f54815e --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +# This is the placeholder file used by GHA. \ No newline at end of file