From fc1ec145504ee2a4f9bc8577ceadf37cfb537ba4 Mon Sep 17 00:00:00 2001
From: Robert Grzesik <rob.grzesik@gmail.com>
Date: Wed, 31 Jan 2024 16:44:04 -0500
Subject: [PATCH] renamed folder and updated readme

---
 README.rst                                            | 6 ++++++
 {quantstats => quantstats_lumi}/__init__.py           | 0
 {quantstats => quantstats_lumi}/_plotting/__init__.py | 0
 {quantstats => quantstats_lumi}/_plotting/core.py     | 0
 {quantstats => quantstats_lumi}/_plotting/wrappers.py | 0
 {quantstats => quantstats_lumi}/plots.py              | 2 +-
 {quantstats => quantstats_lumi}/report.html           | 0
 {quantstats => quantstats_lumi}/reports.py            | 0
 {quantstats => quantstats_lumi}/stats.py              | 0
 {quantstats => quantstats_lumi}/utils.py              | 0
 {quantstats => quantstats_lumi}/version.py            | 0
 11 files changed, 7 insertions(+), 1 deletion(-)
 rename {quantstats => quantstats_lumi}/__init__.py (100%)
 rename {quantstats => quantstats_lumi}/_plotting/__init__.py (100%)
 rename {quantstats => quantstats_lumi}/_plotting/core.py (100%)
 rename {quantstats => quantstats_lumi}/_plotting/wrappers.py (100%)
 rename {quantstats => quantstats_lumi}/plots.py (94%)
 rename {quantstats => quantstats_lumi}/report.html (100%)
 rename {quantstats => quantstats_lumi}/reports.py (100%)
 rename {quantstats => quantstats_lumi}/stats.py (100%)
 rename {quantstats => quantstats_lumi}/utils.py (100%)
 rename {quantstats => quantstats_lumi}/version.py (100%)

diff --git a/README.rst b/README.rst
index 60ba50d..dfa3b08 100644
--- a/README.rst
+++ b/README.rst
@@ -58,6 +58,12 @@ Here's an example of a simple tear sheet analyzing a strategy:
 Quick Start
 ===========
 
+Install QuantStats using pip:
+
+.. code:: bash
+
+	$ pip install quantstats_lumi
+
 .. code:: python
 
     %matplotlib inline
diff --git a/quantstats/__init__.py b/quantstats_lumi/__init__.py
similarity index 100%
rename from quantstats/__init__.py
rename to quantstats_lumi/__init__.py
diff --git a/quantstats/_plotting/__init__.py b/quantstats_lumi/_plotting/__init__.py
similarity index 100%
rename from quantstats/_plotting/__init__.py
rename to quantstats_lumi/_plotting/__init__.py
diff --git a/quantstats/_plotting/core.py b/quantstats_lumi/_plotting/core.py
similarity index 100%
rename from quantstats/_plotting/core.py
rename to quantstats_lumi/_plotting/core.py
diff --git a/quantstats/_plotting/wrappers.py b/quantstats_lumi/_plotting/wrappers.py
similarity index 100%
rename from quantstats/_plotting/wrappers.py
rename to quantstats_lumi/_plotting/wrappers.py
diff --git a/quantstats/plots.py b/quantstats_lumi/plots.py
similarity index 94%
rename from quantstats/plots.py
rename to quantstats_lumi/plots.py
index 1ebe38e..fd32366 100644
--- a/quantstats/plots.py
+++ b/quantstats_lumi/plots.py
@@ -25,4 +25,4 @@
 except ImportError:
     pass
 
-from quantstats._plotting.wrappers import *
+from quantstats_lumi._plotting.wrappers import *
diff --git a/quantstats/report.html b/quantstats_lumi/report.html
similarity index 100%
rename from quantstats/report.html
rename to quantstats_lumi/report.html
diff --git a/quantstats/reports.py b/quantstats_lumi/reports.py
similarity index 100%
rename from quantstats/reports.py
rename to quantstats_lumi/reports.py
diff --git a/quantstats/stats.py b/quantstats_lumi/stats.py
similarity index 100%
rename from quantstats/stats.py
rename to quantstats_lumi/stats.py
diff --git a/quantstats/utils.py b/quantstats_lumi/utils.py
similarity index 100%
rename from quantstats/utils.py
rename to quantstats_lumi/utils.py
diff --git a/quantstats/version.py b/quantstats_lumi/version.py
similarity index 100%
rename from quantstats/version.py
rename to quantstats_lumi/version.py