diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e4a92180..12998b63 100644 --- 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 new file mode 100644 index 00000000..fb93aa93 --- /dev/null +++ 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 `_. + +Installation +------------ + +You can install ``visions`` via pip: + +.. code-block:: console + + pip install visions + +Alternatives and more details can be found in the `documentation `_. + +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 `_. +The `the Github issues tracker `_ is used for reporting bugs, feature requests and support questions. + +Acknowledgements +---------------- + +This package is part of the `dylan-profiler `_ project. +The package is core component of `pandas-profiling `_. +More information can be found `here `__. +This work was partially supported by `SIDN Fonds `_. + + +.. 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 index 1fe522ac..eca5df5c 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -3,7 +3,7 @@ - Overview: module code — visions 0.7.4 documentation + Overview: module code — visions 0.7.5 documentation