Sync to dev

.github/workflows/build.yml

@@ -0,0 +1,43 @@
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+name: build
+jobs:
+    py-check:
+        runs-on: ${{ matrix.config.os }}
+        name: ${{ matrix.config.os }} (${{ matrix.config.py }})
+        strategy:
+            fail-fast: false
+            matrix:
+                config:
+                    # - { os: windows-latest, py: "3.7" }
+                    # - { os: macOS-latest, py: "3.7" }
+                    - { os: ubuntu-latest, py: "3.6" }
+                    - { os: ubuntu-latest, py: "3.7" }
+                    - { os: ubuntu-latest, py: "3.8" }
+                    - { os: ubuntu-latest, py: "3.9" }
+                    - { os: ubuntu-latest, py: "3.10" }
+
+        env:
+            SDKROOT: /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk
+        steps:
+            - name: CHECKOUT CODE
+              uses: actions/checkout@v2
+            - name: SETUP PYTHON
+              uses: actions/setup-python@v1
+              with:
+                  python-version: ${{ matrix.config.py }}
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --user --no-cache-dir Cython
+                  pip install --user -r requirements.txt
+                  pip install --user -r requirements_dev.txt
+            - name: PKG-TEST
+              run: |
+                  python -m unittest discover tests/

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+      fail-fast: false
+
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/') && github.event_name == 'release'
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: pip install setuptools wheel twine
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: "Pull Request Docs Check"
+on: 
+- pull_request
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationHTML
+        path: docs/_build/html/
+
+    - name: Commit documentation changes
+      run: |
+        git clone https://github.com/your_git/repository.git --branch gh-pages --single-branch gh-pages
+        cp -r docs/_build/html/* gh-pages/
+        cd gh-pages
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add .
+        git commit -m "Update documentation" -a || true
+        # The above command will fail if no changes were present, so we ignore
+        # the return code.
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        branch: gh-pages
+        directory: gh-pages
+        github_token: ${{ secrets.GITHUB_TOKEN }} 

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+# This workflow will upload a python package uing twine when a release is triggered
+
+name: publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERS }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.travis.yml

@@ -3,6 +3,11 @@ os:
   - osx
   - windows
 
+dist:
+  - bionic
+  - focal
+  - Jammy
+
 jobs:
   allow_failures:
     - os: osx
@@ -12,7 +17,7 @@ language: python
 python:
 - 3.8
 - 3.9
-- '3.10'
+- 3.10
 
 install: pip install -U tox-travis
 script: tox
@@ -26,4 +31,4 @@ deploy:
   on:
     tags: true
     repo: shankarpandala/lazypredict
-    python: 3.x
+    python: 3.9

AUTHORS.md

@@ -0,0 +1,11 @@
+---
+title: Credits
+---
+
+# Development Lead
+
+-   Shankar Rao Pandala \<<[email protected]>\>
+
+# Contributors
+
+-   Breno Batista da Silva \<<[email protected]>\>

CONTRIBUTING.md

@@ -0,0 +1,139 @@
+---
+title: Contributing
+---
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+# Types of Contributions
+
+## Report Bugs
+
+Report bugs at <https://github.com/shankarpandala/lazypredict/issues>.
+
+If you are reporting a bug, please include:
+
+-   Your operating system name and version.
+-   Any details about your local setup that might be helpful in
+    troubleshooting.
+-   Detailed steps to reproduce the bug.
+
+## Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with \"bug\"
+and \"help wanted\" is open to whoever wants to implement it.
+
+## Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+\"enhancement\" and \"help wanted\" is open to whoever wants to
+implement it.
+
+## Write Documentation
+
+Lazy Predict could always use more documentation, whether as part of the
+official Lazy Predict docs, in docstrings, or even on the web in blog
+posts, articles, and such.
+
+## Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/shankarpandala/lazypredict/issues>.
+
+If you are proposing a feature:
+
+-   Explain in detail how it would work.
+-   Keep the scope as narrow as possible, to make it easier to
+    implement.
+-   Remember that this is a volunteer-driven project, and that
+    contributions are welcome :)
+
+# Get Started!
+
+Ready to contribute? Here\'s how to set up [lazypredict]{.title-ref} for
+local development.
+
+1.  Fork the [lazypredict]{.title-ref} repo on GitHub.
+
+2.  Clone your fork locally:
+
+    ``` shell
+    $ git clone [email protected]:your_name_here/lazypredict.git
+    ```
+
+3.  Install your local copy into a virtualenv. Assuming you have
+    virtualenvwrapper installed, this is how you set up your fork for
+    local development:
+
+    ``` shell
+    $ mkvirtualenv lazypredict
+    $ cd lazypredict/
+    $ python setup.py develop
+    $ pip install -r requirements_dev.txt
+    ```
+
+4.  Create a branch for local development:
+
+    ``` shell
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+    Now you can make your changes locally.
+
+5.  When you\'re done making changes, check that your changes pass
+    flake8 and the tests, including testing other Python versions with
+    tox:
+
+    ``` shell
+    $ flake8 lazypredict tests
+    $ python setup.py test or pytest
+    $ tox
+    ```
+
+    To get flake8 and tox, just pip install them into your virtualenv.
+
+6.  Commit your changes and push your branch to GitHub:
+
+    ``` shell
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7.  Submit a pull request through the GitHub website.
+
+# Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1.  The pull request should include tests.
+2.  If the pull request adds functionality, the docs should be updated.
+    Put your new functionality into a function with a docstring, and add
+    the feature to the list in README.rst.
+3.  The pull request should work for Python 2.7, 3.5, 3.6, 3.7 and 3.8,
+    and for PyPy. Check
+    <https://travis-ci.org/shankarpandala/lazypredict/pull_requests> and
+    make sure that the tests pass for all supported Python versions.
+
+# Tips
+
+To run a subset of tests:
+
+``` shell
+$ pytest tests.test_lazypredict
+```
+
+# Deploying
+
+A reminder for the maintainers on how to deploy. Make sure all your
+changes are committed (including an entry in HISTORY.rst). Then run:
+
+``` shell
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+```
+
+Travis will then deploy to PyPI if tests pass.