dynamic GH version

icometrix · Feb 2, 2024 · 0024312 · 0024312
1 parent 27ca08d
commit 0024312
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,13 +12,15 @@
 root_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "../.."))
 sys.path.insert(0, root_path)
 
+from icometrix_sdk._version import __version__
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "icometrix-sdk"
 copyright = f"{date.today().year}, icometrix"
 author = "icometrix"
-release = "0.0.1"
+release = __version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -27,6 +29,11 @@
     "sphinx.ext.autodoc"
 ]
 
+# sphinx.ext.autodoc options
+autodoc_default_options = {
+    'exclude-members': 'model_config, model_fields'  # exclude pydantic internal fields
+}
+
 templates_path = ["_templates"]
 exclude_patterns = []
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,9 +1,30 @@
-icometrix-sdk
-=============
+icometrix-sdk documentation
+===========================
+
+A library that provides a Python interface for the Icometrix API.
+
+Quickstart
+----------
 
 .. toctree::
-   :hidden:
    :maxdepth: 2
 
    quickstart
+
+
+API reference
+-------------
+
+.. toctree::
+   :maxdepth: 2
+
    resources/index
+
+
+Models
+------
+
+.. toctree::
+   :maxdepth: 2
+
+   models/index
diff --git a/docs/models/base.rst b/docs/models/base.rst
@@ -0,0 +1,6 @@
+Patient
+=======
+
+.. automodule:: icometrix_sdk.models.base
+   :members:
+   :undoc-members:
diff --git a/docs/models/customer_report.rst b/docs/models/customer_report.rst
@@ -0,0 +1,6 @@
+Customer Report
+===============
+
+.. automodule:: icometrix_sdk.models.customer_report_entity
+   :members:
+   :undoc-members:
diff --git a/docs/models/index.rst b/docs/models/index.rst
@@ -0,0 +1,11 @@
+Models
+======
+
+.. toctree::
+
+    customer_report
+    patient
+    project
+    upload
+    user
+    base
diff --git a/docs/models/patient.rst b/docs/models/patient.rst
@@ -0,0 +1,6 @@
+Patient
+=======
+
+.. automodule:: icometrix_sdk.models.patient_entity
+   :members:
+   :undoc-members:
diff --git a/docs/models/project.rst b/docs/models/project.rst
@@ -0,0 +1,6 @@
+Project
+=======
+
+.. automodule:: icometrix_sdk.models.project_entity
+   :members:
+   :undoc-members:
diff --git a/docs/models/upload.rst b/docs/models/upload.rst
@@ -0,0 +1,6 @@
+Upload
+======
+
+.. automodule:: icometrix_sdk.models.upload_entity
+   :members:
+   :undoc-members:
diff --git a/docs/models/user.rst b/docs/models/user.rst
@@ -0,0 +1,6 @@
+User
+====
+
+.. automodule:: icometrix_sdk.models.user_entity
+   :members:
+   :undoc-members:
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -12,6 +12,7 @@ icometrix_sdk can be installed with `pip <https://pip.pypa.io>`_
 
   $ python -m pip install icometrix_sdk
 
+
 Authentication
 ---------------
 

diff --git a/gh-version.sh b/gh-version.sh
@@ -0,0 +1,11 @@
+#!/bin/sh
+
+# from refs/tags/v1.2.3 get 1.2.3
+VERSION=$(echo $GITHUB_REF | sed 's#.*/v##')
+PLACEHOLDER='__version__ = "develop"'
+VERSION_FILE='icometrix_sdk/_version.py'
+
+# ensure the placeholder is there. If grep doesn't find the placeholder
+# it exits with exit code 1 and github actions aborts the build.
+grep "$PLACEHOLDER" "$VERSION_FILE"
+sed -i "s/$PLACEHOLDER/__version__ = \"${VERSION}\"/g" "$VERSION_FILE"
diff --git a/icometrix_sdk/_version.py b/icometrix_sdk/_version.py
@@ -1 +1 @@
-__version__ = "0.0.2"
+__version__ = "develop"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,6 +12,7 @@ icometrix_sdk can be installed with `pip <https://pip.pypa.io>`_

		$ python -m pip install icometrix_sdk


		Authentication
		---------------

Expand Down