Skip to content

🖋️ Scribe: Fix execution commands and bash syntax in examples #762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fderuiter merged 2 commits into from
Apr 2, 2026
Merged

🖋️ Scribe: Fix execution commands and bash syntax in examples #762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d70e30
docs: fix python commands to use poetry in examples
fderuiter Apr 2, 2026
eab8840
docs: fix python commands to use poetry in examples
fderuiter Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/examples/async_quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/export_long_sql.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Environment variables

export IMEDNET_API_KEY
export IMEDNET_SECURITY_KEY
export IMEDNET_BASE_URL (optional)
# export IMEDNET_BASE_URL

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_codings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_record_revisions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_records.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_records_async.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Environment variables

export IMEDNET_API_KEY
export IMEDNET_SECURITY_KEY
export IMEDNET_BASE_URL (optional)
# export IMEDNET_BASE_URL

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_sites.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_studies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Environment variables

export IMEDNET_API_KEY
export IMEDNET_SECURITY_KEY
export IMEDNET_BASE_URL (optional)
# export IMEDNET_BASE_URL

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_study_structure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_subjects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_users.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/get_visits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/post_register_subjects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Environment variables

export IMEDNET_API_KEY
export IMEDNET_SECURITY_KEY
export IMEDNET_BASE_URL (optional)
# export IMEDNET_BASE_URL

Description
-----------
Expand Down
2 changes: 1 addition & 1 deletion docs/form_builder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
10 changes: 10 additions & 0 deletions docs/imednet.cli.intervals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
imednet.cli.intervals package
=============================

Module contents
---------------

.. automodule:: imednet.cli.intervals
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/retry_policy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion examples/async_quick_start.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""


Expand Down
2 changes: 1 addition & 1 deletion examples/basic/get_studies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
"""


Expand Down
3 changes: 2 additions & 1 deletion examples/build_form_payload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/custom_retry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""


Expand Down
4 changes: 2 additions & 2 deletions examples/export_long_sql.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/quick_start.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""


Expand Down
Loading