Merge pull request #143 from mdsol/feature/car_mode_update

Feature/car mode update

Author: glow-mdsol

.github/workflows/main.yml

@@ -20,8 +20,8 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: "actions/checkout@v2"
-      - uses: "actions/setup-python@v2"
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: "${{ matrix.python-version }}"
       # Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow
@@ -30,7 +30,7 @@ jobs:
       # manually if/when you want to upgrade Poetry, or if something goes wrong. This could be
       # mildly cleaner by using an environment variable, but I don't really care.
       - name: cache poetry install
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.local
           key: poetry-1.4.2-0
@@ -53,7 +53,7 @@ jobs:
       # them in the cache key. I'm not, so it can be simple and just depend on the poetry.lock.
       - name: cache deps
         id: cache-deps
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: .venv
           key: pydeps-${{ hashFiles('**/poetry.lock') }}

.readthedocs.yaml

@@ -3,18 +3,18 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
-  tools: {python: "3.10"}
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
   jobs:
-    pre_create_environment:
-      - asdf plugin add poetry
-      - asdf install poetry latest
-      - asdf global poetry latest
+    post_create_environment:
+      - pip install poetry
       - poetry config virtualenvs.create false
     post_install:
       - poetry install --with docs
 
-# Build documentation in the docs/ directory with Sphinx
+
+# Build documentation using Sphinx
 sphinx:
   configuration: docs/source/conf.py
-  fail_on_warning: true
+  fail_on_warning: true

docs/Makefile

@@ -3,14 +3,14 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = poetry run sphinx-build
 PAPER         =
 BUILDDIR      = build
 
 # User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
+#ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+#$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+#endif
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4

docs/source/biostats_gateway.rst

@@ -10,7 +10,7 @@ Many of the Biostats gateway requests pull data from the Rave Clinical Views. Th
 Clinical Views are active in Rave.
 
 Read more about Biostats Gateway in the
-`Rave Web Services documentation <http://rws-webhelp.s3.amazonaws.com/WebHelp_ENG/solutions/01_biostat_adapter.html>`_
+`Rave Web Services documentation <https://learn.medidata.com/en-US/bundle/rave-web-services/page/biostat_adapter.html>`_
 
 
 .. _cv_metadata_request:

docs/source/classes_builders.rst

@@ -21,15 +21,6 @@ Clinical Data Builders provide an API for creating ODM data elements
     :exclude-members: build
 
 
-Medidata Extensions to ODM (MODM) Builders
-==========================================
-MODM Builders provide an API for creating ODM data elements meeting the Medidata Rave specific extensions to the MODM specification
-
-.. automodule:: rwslib.builders.clinicaldata
-    :members:
-    :exclude-members: build
-
-
 Administrative Data Builders
 ============================
 Admin Data Builders provide an API for creating ODM AdminData elements

docs/source/conf.py

@@ -11,20 +11,14 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-parentdir = os.path.split(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))[0]
-sys.path.insert(0,str(parentdir))
+from sphinx_pyproject import SphinxConfig
 
-import pkg_resources
-__version__ = pkg_resources.get_distribution('rwslib').version
+config = SphinxConfig("../../pyproject.toml", globalns=globals(), style="poetry")
 
-from rwslib import  __copyright__
 
 # -- General configuration -----------------------------------------------------
 
@@ -48,17 +42,11 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'rwslib'
-copyright = __copyright__
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-
-
-# The short X.Y version.
-version = __version__
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/source/odm_adapter.rst

@@ -12,7 +12,7 @@ The ODM Adapter module provides Request implementations for the Rave Web Service
 * Signature Definitions Dataset
 
 Read more about ODM Adapter in the
-`Rave Web Services documentation <http://rws-webhelp.s3.amazonaws.com/WebHelp_ENG/solutions/clinical_data_audits/index.html#odm-adapter>`_
+`Rave Web Services documentation <https://learn.medidata.com/en-US/bundle/rave-web-services/page/odm_operational_data_model_adapter.html>`_
 
 
 .. _oa_auditrecords_request:
@@ -40,6 +40,12 @@ Options:
 +--------------------------------+-----------------------------------------------------------------------------------+
 | per_page=100                   | How many audits to return per request. Default is 100.                            |
 +--------------------------------+-----------------------------------------------------------------------------------+
+| mode=[default,enhanced,all]    | Define what AuditSubcategories to return                                          |
++--------------------------------+-----------------------------------------------------------------------------------+
+
+*NOTE*
+* The `mode` parameter is only available in Rave EDC 2022.3.0 and later.
+* See `this link <https://learn.medidata.com/en-US/bundle/rave-web-services/page/retrieve_clinical_data_with_the_clinical_audit_records_dataset.html>`_ for more information on the `mode` parameter.
 
 Example::