refactor analyze module and restructure databases

revitron · Dec 9, 2021 · 157a54c · 157a54c
1 parent 98c5fd8
commit 157a54c
Show file tree

Hide file tree

Showing 12 changed files with 456 additions and 330 deletions.
diff --git a/cli/run/analyze.py b/cli/run/analyze.py
@@ -28,5 +28,5 @@
 config = revitron.AttrDict(json.load(file))
 file.close()
 
-analyzer = revitron.ModelAnalyzer(config.database, config.providers, config.model)
+analyzer = revitron.ModelAnalyzer(config)
 analyzer.snapshot()
diff --git a/docs/source/_templates/package.rst_t b/docs/source/_templates/package.rst_t
@@ -16,7 +16,11 @@
 {%- if is_namespace %}
 {{- [pkgname, "namespace"] | join(" ") | e | heading }}
 {% else %}
-{{- "Developer Guide" | e | heading }}
+	{%- if pkgname == "revitron" %}
+		{{- "Developer Guide" | e | heading }}
+	{% else %}
+		{{- pkgname | e | heading }}
+	{% endif %}
 {% endif %}
 
 {%- if modulefirst and not is_namespace %}

diff --git a/docs/source/analyze.rst b/docs/source/analyze.rst
@@ -0,0 +1,20 @@
+Model Analytics
+===============
+
+Revitron ships with a small CLI wrapper that uses the pyRevit CLI in the background in order to
+collect model analytics using some kind of task scheduler such as the *Windows Task Scheduler*.
+
+.. code-block:: python
+
+    revitron analyse "path/to/config.json"
+
+Setup
+-----
+
+Run setup to add to path ...
+
+Configuration
+-------------
+
+use config file
+
diff --git a/docs/source/revitron.analyze.providers.rst b/docs/source/revitron.analyze.providers.rst
@@ -0,0 +1,9 @@
+revitron.analyze.providers
+==========================
+
+.. automodule:: revitron.analyze.providers
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+   :autosummary:
diff --git a/docs/source/revitron.analyze.rst b/docs/source/revitron.analyze.rst
@@ -1,9 +1,17 @@
 revitron.analyze
 ================
+
 
 .. automodule:: revitron.analyze
    :members:
    :undoc-members:
-   :inherited-members:
    :show-inheritance:
-   :autosummary:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   revitron.analyze.providers
+   revitron.analyze.storage
diff --git a/docs/source/revitron.analyze.storage.rst b/docs/source/revitron.analyze.storage.rst
@@ -0,0 +1,9 @@
+revitron.analyze.storage
+========================
+
+.. automodule:: revitron.analyze.storage
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+   :autosummary:
diff --git a/docs/source/revitron.rst b/docs/source/revitron.rst
@@ -1,18 +1,26 @@
 Developer Guide
 ===============
+
 
 .. automodule:: revitron
    :members:
    :undoc-members:
    :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   revitron.analyze
+
 Submodules
 ----------
 
 .. toctree::
    :maxdepth: 4
 
-   revitron.analyze
    revitron.boundingbox
    revitron.category
    revitron.create

diff --git a/revitron/__init__.py b/revitron/__init__.py
@@ -84,8 +84,8 @@
 import pyrevit
 import os
 
-from revitron.analyze import *
 from revitron._utils import *
+from revitron.analyze import *
 from revitron.boundingbox import *
 from revitron.element import *
 from revitron.excel import *