The tool library is aimed at guiding data scientists with their analysis using custom widgets inside Jupyter Notebook.
Project description
bring-order
The tool is aimed at guiding data scientists with their analysis using custom widgets inside Jupyter Notebook. User can import and prepare data for analysis, add limitations and perform deductive or inductive analysis. Deductive analysis asks the user to set the hypothesis and null hypothesis, run their analysis, and confirm one of the hypotheses. Inductive analysis is an option to perform explorative analysis and write notes about it.
Documentation
Installation
Installation from PyPi
Linux
- If you don't have Jupyter Notebook installed, install it with
pip install notebook
- If you don't have ipywidgets installed, install it with
pip install ipywidgets
- If you have an old version of ipywidgets installed, upgrade it with
pip install --upgrade ipywidgets
- Install bring-order extention:
pip install bring-order
Windows
-
If you don't have Jupyter Notebook installed, install Anaconda with Anaconda download
-
Use Anaconda Powershell Prompt
-
If you don't have ipywidgets installed, install it with
pip install ipywidgets
- If you have an old version of ipywidgets installed, upgrade it with
pip install --upgrade ipywidgets
- Install bring-order extention:
pip install bring-order
MacOS
- If you don't have ipywidgets installed, install it with
python3 -m pip install "ipywidgets"
- If you have an old version of ipywidgets installed, upgrade it with
python3 -m pip install --upgrade ipywidgets
- Install bring-order extention:
python3 -m pip install "bring-order"
Usage
- Open Jupyter Notebook with
jupyter notebook
- In Jupyter Notebook execute
from bring_order import BringOrder or from bring_order import *
- Start using package by executing
BringOrder()
- Make sure that your notebook is in Trusted state. Otherwise the widgets might not work correctly.
Development
Dependencies
- Clone the project and install dependencies in the main folder
poetry install
Testing
- Navigate to main folder and go to the virtual environment
poetry shell
Run unit tests
pytest tests
Run style check
pylint bringorder
Run robot tests
- Make sure you have chromedriver installed and matching your Chrome version before running
./run_robot_tests.sh
- If the script won't run, give it execution rights first and try again
chmod +x run_robot_tests.sh
- If the first run fails, try once again. Sometimes there are some connection issues. When you are done, you can exit the virtual environment with command
exit
Run tests with Invoke
- The previous tests can also be run using Invoke in poetry shell:
invoke tests
to run unit tests
invoke lint
to run pylint
invoke robottests
to run robottests
invoke alltests
to run all of the above
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bring_order-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70f6e5ffc1371f0d5e0eca2bac901f2d6546b0168d9eb793fabd0004fbcad78c |
|
MD5 | cbdcbfc7174858945c6d35ceb69f066b |
|
BLAKE2b-256 | baaff7eb34cf1e9f3138bd29583d76c3370685c54bbb9b1467956aae2f37e0c0 |