diff --git a/docs/examples/async_quick_start.rst b/docs/examples/async_quick_start.rst index f362c59c..40e7c895 100644 --- a/docs/examples/async_quick_start.rst +++ b/docs/examples/async_quick_start.rst @@ -14,9 +14,9 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY - export IMEDNET_BASE_URL (optional) - export IMEDNET_JOB_STUDY_KEY (optional) - export IMEDNET_BATCH_ID (optional) + # export IMEDNET_BASE_URL + # export IMEDNET_JOB_STUDY_KEY + # export IMEDNET_BATCH_ID Description ----------- diff --git a/docs/examples/export_long_sql.rst b/docs/examples/export_long_sql.rst index ca0814bb..d70ac08b 100644 --- a/docs/examples/export_long_sql.rst +++ b/docs/examples/export_long_sql.rst @@ -14,7 +14,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_codings.rst b/docs/examples/get_codings.rst index 75b8e89e..882f6036 100644 --- a/docs/examples/get_codings.rst +++ b/docs/examples/get_codings.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_record_revisions.rst b/docs/examples/get_record_revisions.rst index 02a4a2e7..6f030752 100644 --- a/docs/examples/get_record_revisions.rst +++ b/docs/examples/get_record_revisions.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_records.rst b/docs/examples/get_records.rst index 6430a460..5f7fe55f 100644 --- a/docs/examples/get_records.rst +++ b/docs/examples/get_records.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_records_async.rst b/docs/examples/get_records_async.rst index da56dea3..1ccfa0b5 100644 --- a/docs/examples/get_records_async.rst +++ b/docs/examples/get_records_async.rst @@ -14,7 +14,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_sites.rst b/docs/examples/get_sites.rst index c7df8956..273d3f25 100644 --- a/docs/examples/get_sites.rst +++ b/docs/examples/get_sites.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_studies.rst b/docs/examples/get_studies.rst index 7f844325..a7b47222 100644 --- a/docs/examples/get_studies.rst +++ b/docs/examples/get_studies.rst @@ -14,7 +14,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_study_structure.rst b/docs/examples/get_study_structure.rst index 542f9fd6..de009d48 100644 --- a/docs/examples/get_study_structure.rst +++ b/docs/examples/get_study_structure.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_subjects.rst b/docs/examples/get_subjects.rst index c5b172e5..489d7562 100644 --- a/docs/examples/get_subjects.rst +++ b/docs/examples/get_subjects.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_users.rst b/docs/examples/get_users.rst index 030ab09b..3308d6db 100644 --- a/docs/examples/get_users.rst +++ b/docs/examples/get_users.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_variables.rst b/docs/examples/get_variables.rst index 2b9aebdf..426c099a 100644 --- a/docs/examples/get_variables.rst +++ b/docs/examples/get_variables.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/get_visits.rst b/docs/examples/get_visits.rst index 6fccad42..9c57874b 100644 --- a/docs/examples/get_visits.rst +++ b/docs/examples/get_visits.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/post_register_subjects.rst b/docs/examples/post_register_subjects.rst index 61ae86f6..3d1317fa 100644 --- a/docs/examples/post_register_subjects.rst +++ b/docs/examples/post_register_subjects.rst @@ -15,7 +15,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY export IMEDNET_STUDY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/examples/quick_start.rst b/docs/examples/quick_start.rst index 4ff8c543..0ebe8ed6 100644 --- a/docs/examples/quick_start.rst +++ b/docs/examples/quick_start.rst @@ -14,7 +14,7 @@ Environment variables export IMEDNET_API_KEY export IMEDNET_SECURITY_KEY - export IMEDNET_BASE_URL (optional) + # export IMEDNET_BASE_URL Description ----------- diff --git a/docs/form_builder.rst b/docs/form_builder.rst index f679bcd4..fb277dd7 100644 --- a/docs/form_builder.rst +++ b/docs/form_builder.rst @@ -45,7 +45,7 @@ For CI/CD or automated workflows, use the example script: .. code-block:: console - python examples/build_form_payload.py --preset "Demo Form" \ + poetry run python examples/build_form_payload.py --preset "Demo Form" \ --base-url "https://your.imednet.com" \ --phpsessid "YOUR_SESSION_ID" \ --csrf "YOUR_CSRF_KEY" \ diff --git a/docs/imednet.cli.intervals.rst b/docs/imednet.cli.intervals.rst new file mode 100644 index 00000000..d8410ba4 --- /dev/null +++ b/docs/imednet.cli.intervals.rst @@ -0,0 +1,10 @@ +imednet.cli.intervals package +============================= + +Module contents +--------------- + +.. automodule:: imednet.cli.intervals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/retry_policy.rst b/docs/retry_policy.rst index d847f05a..2a060b32 100644 --- a/docs/retry_policy.rst +++ b/docs/retry_policy.rst @@ -67,4 +67,4 @@ transport: export IMEDNET_API_KEY=dummy export IMEDNET_SECURITY_KEY=dummy - python examples/custom_retry.py + poetry run python examples/custom_retry.py diff --git a/examples/async_quick_start.py b/examples/async_quick_start.py index 6c6ebb38..3cfcdbbe 100644 --- a/examples/async_quick_start.py +++ b/examples/async_quick_start.py @@ -17,7 +17,7 @@ export IMEDNET_API_KEY="your_api_key" export IMEDNET_SECURITY_KEY="your_security_key" - python examples/async_quick_start.py + poetry run python examples/async_quick_start.py """ diff --git a/examples/basic/get_studies.py b/examples/basic/get_studies.py index b7bd2d09..8806821d 100644 --- a/examples/basic/get_studies.py +++ b/examples/basic/get_studies.py @@ -17,7 +17,7 @@ Usage: 1. Ensure your environment variables are set correctly (e.g. `export IMEDNET_API_KEY="..."`). -2. Run the script: `python examples/basic/get_studies.py` +2. Run the script: `poetry run python examples/basic/get_studies.py` """ diff --git a/examples/build_form_payload.py b/examples/build_form_payload.py index 872662a7..92bbba3d 100644 --- a/examples/build_form_payload.py +++ b/examples/build_form_payload.py @@ -4,7 +4,8 @@ Usage: # Headless Mode (CLI) - python examples/build_form_payload.py --preset "Demo Form" --form-id 123 --revision 5 ... + poetry run python examples/build_form_payload.py \ + --preset "Demo Form" --form-id 123 --revision 5 """ import argparse diff --git a/examples/custom_retry.py b/examples/custom_retry.py index 984caae8..64f15288 100644 --- a/examples/custom_retry.py +++ b/examples/custom_retry.py @@ -21,7 +21,7 @@ export IMEDNET_API_KEY="dummy" export IMEDNET_SECURITY_KEY="dummy" - python examples/custom_retry.py + poetry run python examples/custom_retry.py """ diff --git a/examples/export_long_sql.py b/examples/export_long_sql.py index f19cae30..3ca9f413 100644 --- a/examples/export_long_sql.py +++ b/examples/export_long_sql.py @@ -12,7 +12,7 @@ Optionally set ``IMEDNET_BASE_URL`` for non-default instances. Usage: - python examples/export_long_sql.py STUDY_KEY TABLE_NAME OUTPUT_DB + poetry run python examples/export_long_sql.py STUDY_KEY TABLE_NAME OUTPUT_DB The ``OUTPUT_DB`` path is used to build the SQLite connection string. """ @@ -23,7 +23,7 @@ def main() -> None: if len(sys.argv) != 4: print( - "Usage: python examples/export_long_sql.py STUDY_KEY TABLE_NAME OUTPUT_DB", + "Usage: poetry run python examples/export_long_sql.py STUDY_KEY TABLE_NAME OUTPUT_DB", file=sys.stderr, ) sys.exit(1) diff --git a/examples/quick_start.py b/examples/quick_start.py index 9a249d9c..7053c40c 100644 --- a/examples/quick_start.py +++ b/examples/quick_start.py @@ -14,7 +14,7 @@ export IMEDNET_API_KEY="your_api_key" export IMEDNET_SECURITY_KEY="your_security_key" - python examples/quick_start.py + poetry run python examples/quick_start.py """