merge

dylan-profiler · Feb 6, 2024 · b046981 · b046981
2 parents 5fe9dd0 + dca86aa
commit b046981
Show file tree

Hide file tree

Showing 133 changed files with 299 additions and 195 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,6 +5,7 @@ repos:
     -   id: pyupgrade
         args: ['--py36-plus','--exit-zero-even-if-changed']
 -   repo: https://github.com/pycqa/isort
+
     rev: 5.13.2
     hooks:
       - id: isort
@@ -28,7 +29,13 @@ repos:
     rev: "0.49"
     hooks:
     -   id: check-manifest
-# g
+# -   repo: https://github.com/pre-commit/mirrors-mypy
+#     rev: 'v1.8.0'
+#     hooks:
+#     -   id: mypy
+#         files: '^src/'
+#         additional_dependencies:
+#           - types-attrs
 -   repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:

diff --git a/README.rst b/README.rst
@@ -0,0 +1,90 @@
+Visions
+=======
+
+|JossPaper|
+|PyPiDownloadsBadge|
+|PyPiDownloadsMonthlyBadge|
+|PyPiVersionBadge|
+|PythonBadge|
+|BinderBadge|
+
+..
+
+    *And these visions of data types, they kept us up past the dawn.*
+
+..
+
+``Visions`` provides an extensible suite of tools to support common data analysis operations including
+
+* type inference on unknown data
+* casting data types
+* automated data summarization
+
+
+
+.. image:: https://github.com/dylan-profiler/visions/raw/develop/docsrc/source/_static/side-by-side.png
+
+
+
+Documentation
+-------------
+
+Full documentation can be found `here <https://dylan-profiler.github.io/visions/>`_.
+
+Installation
+------------
+
+You can install ``visions`` via pip:
+
+.. code-block:: console
+
+    pip install visions
+
+Alternatives and more details can be found in the `documentation <https://dylan-profiler.github.io/visions/visions/getting_started/installation.html>`_.
+
+Supported frameworks
+--------------------
+
+These frameworks are supported out-of-the-box in addition to native Python types:
+
+.. image:: https://github.com/dylan-profiler/visions/raw/develop/docsrc/source/_static/frameworks.png
+
+- Pandas (feature complete)
+- Numpy (boolean, complex, date time, float, integer, string, time deltas, string, objects)
+- Spark (boolean, categorical, date, date time, float, integer, numeric, object, string)
+- Python (string, float, integer, date time, time delta, boolean, categorical, object, complex - other datatypes are untested)
+
+Contributing and support
+------------------------
+Contributions to ``visions`` are welcome.
+For more information, please visit the `Community contributions page <https://dylan-profiler.github.io/visions/visions/contributing/contributing.html>`_.
+The `the Github issues tracker <https://github.com/dylan-profiler/visions/issues/new/choose>`_ is used for reporting bugs, feature requests and support questions.
+
+Acknowledgements
+----------------
+
+This package is part of the `dylan-profiler <https://github.com/dylan-profiler>`_ project.
+The package is core component of `pandas-profiling <https://github.com/pandas-profiling/pandas-profiling>`_.
+More information can be found `here <https://dylan-profiler.github.io/visions/visions/background/about.html>`__.
+This work was partially supported by `SIDN Fonds <https://www.sidnfonds.nl/projecten/dylan-data-analysis-leveraging-automatisation>`_.
+
+
+.. image:: https://github.com/dylan-profiler/visions/raw/master/SIDNfonds.png
+
+.. |BinderBadge| image:: https://mybinder.org/badge_logo.svg
+    :target: https://mybinder.org/v2/gh/dylan-profiler/visions/master
+
+.. |JossPaper| image:: https://joss.theoj.org/papers/10.21105/joss.02145/status.svg
+    :target: https://doi.org/10.21105/joss.02145
+
+.. |PythonBadge| image:: https://img.shields.io/pypi/pyversions/visions
+    :target: https://pypi.org/project/visions/
+
+.. |PyPiDownloadsBadge| image:: https://pepy.tech/badge/visions
+    :target: https://pypi.org/project/visions/
+
+.. |PyPiDownloadsMonthlyBadge| image:: https://pepy.tech/badge/visions/month
+    :target: https://pypi.org/project/visions/
+
+.. |PyPiVersionBadge| image:: https://badge.fury.io/py/visions.svg
+    :target: https://pypi.org/project/visions/
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; visions 0.7.4 documentation</title>
+  <title>Overview: module code &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/declarative.html b/docs/_modules/visions/declarative.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.declarative &mdash; visions 0.7.4 documentation</title>
+  <title>visions.declarative &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/functional.html b/docs/_modules/visions/functional.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.functional &mdash; visions 0.7.4 documentation</title>
+  <title>visions.functional &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -215,7 +215,7 @@ <h1>Source code for visions.functional</h1><div class="highlight"><pre>
 <span class="sd">        &gt;&gt;&gt; print(report)</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">padding</span> <span class="o">=</span> <span class="mi">5</span>
-    <span class="n">max_column_length</span> <span class="o">=</span> <span class="nb">max</span><span class="p">([</span><span class="nb">len</span><span class="p">(</span><span class="n">column</span><span class="p">)</span> <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">df</span><span class="o">.</span><span class="n">columns</span><span class="p">])</span> <span class="o">+</span> <span class="n">padding</span>
+    <span class="n">max_column_length</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">column</span><span class="p">)</span> <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">df</span><span class="o">.</span><span class="n">columns</span><span class="p">)</span> <span class="o">+</span> <span class="n">padding</span>
     <span class="n">max_type_length</span> <span class="o">=</span> <span class="mi">30</span>
 
     <span class="n">report</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>

diff --git a/docs/_modules/visions/relations/relations.html b/docs/_modules/visions/relations/relations.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.relations.relations &mdash; visions 0.7.4 documentation</title>
+  <title>visions.relations.relations &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/boolean.html b/docs/_modules/visions/types/boolean.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.boolean &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.boolean &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/categorical.html b/docs/_modules/visions/types/categorical.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.categorical &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.categorical &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/complex.html b/docs/_modules/visions/types/complex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.complex &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.complex &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/count.html b/docs/_modules/visions/types/count.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.count &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.count &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/date.html b/docs/_modules/visions/types/date.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.date &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.date &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/date_time.html b/docs/_modules/visions/types/date_time.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.date_time &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.date_time &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/file.html b/docs/_modules/visions/types/file.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.file &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.file &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/float.html b/docs/_modules/visions/types/float.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.float &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.float &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/generic.html b/docs/_modules/visions/types/generic.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.generic &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.generic &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/geometry.html b/docs/_modules/visions/types/geometry.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.geometry &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.geometry &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/image.html b/docs/_modules/visions/types/image.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.image &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.image &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/integer.html b/docs/_modules/visions/types/integer.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.integer &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.integer &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/ip_address.html b/docs/_modules/visions/types/ip_address.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.ip_address &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.ip_address &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/object.html b/docs/_modules/visions/types/object.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.object &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.object &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/ordinal.html b/docs/_modules/visions/types/ordinal.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.ordinal &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.ordinal &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/path.html b/docs/_modules/visions/types/path.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.path &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.path &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/string.html b/docs/_modules/visions/types/string.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.string &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.string &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/time.html b/docs/_modules/visions/types/time.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.time &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.time &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/time_delta.html b/docs/_modules/visions/types/time_delta.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.time_delta &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.time_delta &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/type.html b/docs/_modules/visions/types/type.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.type &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.type &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/url.html b/docs/_modules/visions/types/url.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.url &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.url &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/types/uuid.html b/docs/_modules/visions/types/uuid.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.types.uuid &mdash; visions 0.7.4 documentation</title>
+  <title>visions.types.uuid &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/typesets/complete_set.html b/docs/_modules/visions/typesets/complete_set.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.typesets.complete_set &mdash; visions 0.7.4 documentation</title>
+  <title>visions.typesets.complete_set &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/typesets/geometry_set.html b/docs/_modules/visions/typesets/geometry_set.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.typesets.geometry_set &mdash; visions 0.7.4 documentation</title>
+  <title>visions.typesets.geometry_set &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/typesets/standard_set.html b/docs/_modules/visions/typesets/standard_set.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.typesets.standard_set &mdash; visions 0.7.4 documentation</title>
+  <title>visions.typesets.standard_set &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

diff --git a/docs/_modules/visions/typesets/typeset.html b/docs/_modules/visions/typesets/typeset.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>visions.typesets.typeset &mdash; visions 0.7.4 documentation</title>
+  <title>visions.typesets.typeset &mdash; visions 0.7.5 documentation</title>
       <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>