ravix 0.1.0__tar.gz

ravix-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel McGibney
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ravix-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include requirements.txt
+include ravix/data/*.csv
+
+recursive-include ravix *.py
+global-exclude __pycache__ *.pyc *.pyo .DS_Store .Rhistory
+prune tests
+prune notebooks

ravix-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: ravix
+Version: 0.1.0
+Summary: Applied regression modeling and visualization for business analytics
+Home-page: https://github.com/danmcgib/ravix
+Author: Daniel McGibney
+Author-email: dmcgibney@bus.miami.edu
+License: MIT
+Project-URL: Homepage, https://github.com/danielmcgibney/ravix
+Project-URL: Source, https://github.com/danielmcgibney/ravix
+Project-URL: Issues, https://github.com/danielmcgibney/ravix/issues
+Keywords: regression,ols,logistic regression,business analytics,statistics,education,formula
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20
+Requires-Dist: pandas>=1.4
+Requires-Dist: statsmodels>=0.13
+Requires-Dist: matplotlib>=3.5
+Dynamic: license-file
+
+# Ravix
+
+Ravix is a Python package for regression analysis and data visualization. It provides tools for model fitting, prediction, and various types of plots to help visualize your data particularly for regression analysis.
+
+## Features
+
+- Model fitting and prediction with convenient formula notation
+- Streamlined code for plotting (boxplot, histogram, scatter plot, etc.)
+- Regression analysis diagnostic tools
+- Integration with popular libraries like `pandas` and `statsmodels`
+
+## Installation
+
+You can install the package using `pip`:
+
+```sh
+pip install ravix
+```
+
+## Usage
+
+Here are some examples of how to use the key functions in the package.
+
+### Importing the Package
+
+To use the functions provided by the package, import it as follows:
+
+```python
+import ravix
+```
+
+### Getting Data
+
+There are multiple datasets available from Ravix and are easily attained using the `get_data` function.  The datasets currently available are:
+
+* AirBnb.csv
+* Betas.csv
+* Charges.csv
+* Employment.csv
+* HousePrices.csv
+* HR_retention.csv
+* MarketingToys.csv
+* Sales.csv
+* Top200.csv
+* Twitter.csv
+* Youtube.csv
+
+See [Applied Linear Regression for Business Analytics with Python](www.businessregression.com) for details regarding these datasets.  Sample import example:
+
+```python
+import ravix
+
+# Load data from ravix
+df = ravix.get_data("Betas.csv")
+
+# Format the data (for later)
+df.drop(columns = df.columns[0], inplace=True)
+```
+
+### Model Fitting and Prediction
+
+Ravix formula supports formula functionality similar to R. Fit a model with a formula:
+
+```python
+# Fit model with formula 
+model = ravix.ols("SPY ~ .", df)
+```
+
+Summary types are specified using the `out` argument.  Different summaries are available including:
+
+* simple (default)
+* statsmodels 
+* R
+* ANOVA
+* coefficients (coef)
+
+```python
+# Generate a model summary
+ravix.summary(model)
+```
+
+### Making Predictions
+
+A Statsmodels object is created by default.  From this object, the predict function can be used. Since `df` is the dataframe used to fit the model, the following lines produce the same result.
+
+```python
+# Make predictions
+ravix.predict(model, df)
+
+# Produce fitted values
+ravix.predict(model)
+```
+
+### General Plotting
+
+Plotting code is streamlined and built on top of Seaborn and MatPlotLib. Samples provided below.
+
+```python
+# Generate a boxplot
+ravix.boxplot("SPY ~ .", df)
+
+# Generate a histogram
+ravix.hist(df.SPY)
+
+# Multiple histograms
+ravix.hists("SPY ~ .",data = df)
+
+# Scatter plot
+ravix.plot("MSFT ~ SPY", data = df)
+
+# Multiple Scatter plots
+ravix.plot("SPY ~ .", data = df)
+
+# Correlation Plot
+ravix.plot_cor(df)
+```
+
+### Required Fixes
+
+Based on current testing, the following fixes are required:
+
+1. Ensure global scope accessibility for variables.
+2. Adjust summary spacing.
+3. Provide compatibility with `scikit-learn`.
+4. Implement AI-generated summaries.
+5. Allow for additional plotting customization (using kwargs).
+6. Review and improve diagnostic plots.
+7. Provide support for logistic regression and other GLMs.
+8. Provide support for automatic dummy variable retrieval.
+9. Plots should work without formulas.
+
+## Contributing
+
+We welcome contributions to Ravix! If you find a bug or have a feature request, please open an issue on [GitHub](https://github.com/danmcgib/ravix). You can also contribute by:
+
+1. Forking the repository
+2. Creating a new branch (`git checkout -b feature-branch`)
+3. Committing your changes (`git commit -am 'Add some feature'`)
+4. Pushing to the branch (`git push origin feature-branch`)
+5. Creating a pull request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+We would like to thank all contributors and users of Ravix for their support and feedback.

ravix-0.1.0/README.md

@@ -0,0 +1,148 @@
+# Ravix
+
+Ravix is a Python package for regression analysis and data visualization. It provides tools for model fitting, prediction, and various types of plots to help visualize your data particularly for regression analysis.
+
+## Features
+
+- Model fitting and prediction with convenient formula notation
+- Streamlined code for plotting (boxplot, histogram, scatter plot, etc.)
+- Regression analysis diagnostic tools
+- Integration with popular libraries like `pandas` and `statsmodels`
+
+## Installation
+
+You can install the package using `pip`:
+
+```sh
+pip install ravix
+```
+
+## Usage
+
+Here are some examples of how to use the key functions in the package.
+
+### Importing the Package
+
+To use the functions provided by the package, import it as follows:
+
+```python
+import ravix
+```
+
+### Getting Data
+
+There are multiple datasets available from Ravix and are easily attained using the `get_data` function.  The datasets currently available are:
+
+* AirBnb.csv
+* Betas.csv
+* Charges.csv
+* Employment.csv
+* HousePrices.csv
+* HR_retention.csv
+* MarketingToys.csv
+* Sales.csv
+* Top200.csv
+* Twitter.csv
+* Youtube.csv
+
+See [Applied Linear Regression for Business Analytics with Python](www.businessregression.com) for details regarding these datasets.  Sample import example:
+
+```python
+import ravix
+
+# Load data from ravix
+df = ravix.get_data("Betas.csv")
+
+# Format the data (for later)
+df.drop(columns = df.columns[0], inplace=True)
+```
+
+### Model Fitting and Prediction
+
+Ravix formula supports formula functionality similar to R. Fit a model with a formula:
+
+```python
+# Fit model with formula 
+model = ravix.ols("SPY ~ .", df)
+```
+
+Summary types are specified using the `out` argument.  Different summaries are available including:
+
+* simple (default)
+* statsmodels 
+* R
+* ANOVA
+* coefficients (coef)
+
+```python
+# Generate a model summary
+ravix.summary(model)
+```
+
+### Making Predictions
+
+A Statsmodels object is created by default.  From this object, the predict function can be used. Since `df` is the dataframe used to fit the model, the following lines produce the same result.
+
+```python
+# Make predictions
+ravix.predict(model, df)
+
+# Produce fitted values
+ravix.predict(model)
+```
+
+### General Plotting
+
+Plotting code is streamlined and built on top of Seaborn and MatPlotLib. Samples provided below.
+
+```python
+# Generate a boxplot
+ravix.boxplot("SPY ~ .", df)
+
+# Generate a histogram
+ravix.hist(df.SPY)
+
+# Multiple histograms
+ravix.hists("SPY ~ .",data = df)
+
+# Scatter plot
+ravix.plot("MSFT ~ SPY", data = df)
+
+# Multiple Scatter plots
+ravix.plot("SPY ~ .", data = df)
+
+# Correlation Plot
+ravix.plot_cor(df)
+```
+
+### Required Fixes
+
+Based on current testing, the following fixes are required:
+
+1. Ensure global scope accessibility for variables.
+2. Adjust summary spacing.
+3. Provide compatibility with `scikit-learn`.
+4. Implement AI-generated summaries.
+5. Allow for additional plotting customization (using kwargs).
+6. Review and improve diagnostic plots.
+7. Provide support for logistic regression and other GLMs.
+8. Provide support for automatic dummy variable retrieval.
+9. Plots should work without formulas.
+
+## Contributing
+
+We welcome contributions to Ravix! If you find a bug or have a feature request, please open an issue on [GitHub](https://github.com/danmcgib/ravix). You can also contribute by:
+
+1. Forking the repository
+2. Creating a new branch (`git checkout -b feature-branch`)
+3. Committing your changes (`git commit -am 'Add some feature'`)
+4. Pushing to the branch (`git push origin feature-branch`)
+5. Creating a pull request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+We would like to thank all contributors and users of Ravix for their support and feedback.

ravix-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ravix"
+version = "0.1.0"
+description = "Applied regression modeling and visualization for business analytics"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Daniel McGibney" }
+]
+
+keywords = [
+    "regression",
+    "ols",
+    "logistic regression",
+    "business analytics",
+    "statistics",
+    "education",
+    "formula"
+]
+
+dependencies = [
+    "numpy>=1.20",
+    "pandas>=1.4",
+    "statsmodels>=0.13",
+    "matplotlib>=3.5"
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Information Analysis"
+]
+
+[project.urls]
+Homepage = "https://github.com/danielmcgibney/ravix"
+Source = "https://github.com/danielmcgibney/ravix"
+Issues = "https://github.com/danielmcgibney/ravix/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[tool.setuptools.package-data]
+ravix = ["data/*.csv"]

ravix-0.1.0/ravix/__init__.py

@@ -0,0 +1,65 @@
+from ._version import __version__
+
+"""
+Ravix Package
+================
+Applied modeling and visualization for business analytics
+
+Root exports are intentionally kept small and user-facing:
+- Modeling: OLS, logistic, and Poisson regression with summary, prediction, and interval utilities
+- Plots: high-level plotting functions
+- Utils: get_data
+
+Advanced/internal helpers remain available under submodules:
+- ravix.modeling (e.g., format_summary, significance_code, print_* helpers, EvalEnvironment)
+"""
+
+# --- Modeling (public surface) ---
+from .modeling import (
+    bsr, fit, ols, logistic, poisson,
+    intervals, predict,
+    stepwise, summary, xy_split
+)
+
+# --- Plots (public surface) ---
+from .plots import (
+    barplot, boxplot, abline, hist, plot_bsr, plot_cor, plot_cook,
+    plot, plot_intervals, qq, viz
+)
+
+# --- Diagnostics (numeric tests only) ---
+from .diagnostics import (
+    ncv,
+    bp,
+    shapiro,
+    vif,
+)
+
+# --- Transforms (data-modifying utilities) ---
+from .transforms import (
+    box_cox,
+)
+
+
+# --- Helpers
+from ._internal.helpers import get_data
+
+__all__ = [
+    # Version
+    "__version__",
+
+    # Modeling (public)
+    "bp", "bsr", "fit", "ols", "logistic", "poisson",
+    "intervals", "ncv", "predict",
+    "shapiro", "stepwise", "summary", "vif", "xy_split",
+
+    # Transforms (public)
+    "box_cox", 
+    
+    # Plots (public)
+    "barplot", "boxplot", "abline", "hist", "plot_bsr", "plot_cor", "plot_cook",
+    "plot", "plot_intervals", "qq", "viz",
+
+    # Helpers
+    "get_data"
+]

ravix-0.1.0/ravix/_internal/__init__.py

@@ -0,0 +1,6 @@
+"""
+Internal helpers.
+
+This submodule contains private helper functions used internally by Ravix.
+These are not part of the public API and may change without notice.
+"""

ravix-0.1.0/ravix/_internal/helpers.py

@@ -0,0 +1,86 @@
+from importlib import resources
+import pandas as pd
+import warnings
+import os
+
+def get_data(filename=None):
+    """
+    Load data from the package's data directory.
+    """
+
+    # -------------------------------
+    # LIST FILES
+    # -------------------------------
+    if filename is None:
+        try:
+            data_dir = resources.files('ravix').joinpath('data')
+
+            if data_dir.is_dir():
+                # Use Traversable API
+                files = [
+                    f.name for f in data_dir.iterdir()
+                    if f.is_file()
+                    and not f.name.startswith('.')
+                    and f.name != '__init__.py'
+                    and not f.name.endswith('.pyc')
+                ]
+
+                files = sorted(files)
+
+                if files:
+                    print("Available data files in ravix:")
+                    for f in files:
+                        print(f"  - {f}")
+                else:
+                    print("No data files found in ravix package.")
+
+                return None
+            else:
+                print("No data directory found in ravix package.")
+                return []
+
+        except Exception as e:
+            warnings.warn(f"Could not list package data files: {e}", UserWarning)
+            return []
+
+    # -------------------------------
+    # LOAD FROM PACKAGE
+    # -------------------------------
+    try:
+        csv_path = resources.files('ravix').joinpath('data', filename)
+
+        if csv_path.is_file():
+            with csv_path.open('rb') as f:
+                return pd.read_csv(f)
+
+    except Exception:
+        pass
+
+    # -------------------------------
+    # FALLBACK TO FILESYSTEM
+    # -------------------------------
+    if os.path.exists(filename):
+        warnings.warn(
+            f"Loading '{filename}' from filesystem. "
+            f"get_data() is intended for package data files. "
+            f"For external files, please use pd.read_csv() directly.",
+            UserWarning,
+            stacklevel=2
+        )
+        return pd.read_csv(filename)
+
+    # -------------------------------
+    # FILE NOT FOUND
+    # -------------------------------
+    available_files = get_data()  # List files for message
+
+    if available_files:
+        raise FileNotFoundError(
+            f"'{filename}' not found in package data directory or filesystem.\n"
+            f"See above for available package data files."
+        )
+    else:
+        raise FileNotFoundError(
+            f"'{filename}' not found in package data directory or filesystem. "
+            f"Use get_data() for package data files or pd.read_csv() for external files."
+        )

ravix-0.1.0/ravix/_version.py

@@ -0,0 +1,2 @@
+# ravix/_version.py
+__version__ = "0.1.0"