Installing Chartfactor Py

Installing on your computer

System requirements

Python 3.7 or greater

Installing via pip

Chartfactor Py can be installed via pip. Installing the chartfactor package will also install its JupyterLab extension chartfactor-jlab-ext. Use the command below.

pip install chartfactor

It is recommended to use a virtual environment. The sections below covers Jupyter Lab and Jupyter Notebook installs using both virtualenv and conda.

Jupyter Lab

Installing using virtualenv

If you are using virtualenv, you can use the following commands:

# Create virtual env
virtualenv name_of_my_env

# Activate the environment
source name_of_my_env/bin/activate

# Install Jupyter Lab
pip install jupyterlab

# Install chartfactor
pip install chartfactor

Installing using conda

If you are using conda, you can use the following commands:

# Create a new conda environment
conda create -n cenv  python=3.10 -y

# Activate the environment
conda activate cenv

# Install Jupyter Lab
pip install jupyterlab

# Install chartfactor
pip install chartfactor

Jupyter Notebook

Installing using virtualenv

If you are using virtualenv, you can use the following commands:

# Create virtual env
virtualenv name_of_my_env

# Activate the environment
source name_of_my_env/bin/activate

# Install Jupyter Notebook
pip install notebook

# Install chartfactor
pip install chartfactor

Installing using conda

If you are using conda, you can use the following commands:

# Create a new conda environment
conda create -n cenv  python=3.10 -y

# Activate the environment
conda activate cenv

# Install Jupyter Notebook
pip install notebook

# Install chartfactor
pip install chartfactor

Upgrading ChartFactor Py

Chartfactor Py can be upgraded to its latest version with the commands below.

pip install --upgrade chartfactor

The chartfactor-jlab-ext package is its JupyterLab extension.

Uninstalling ChartFactor Py

Chartfactor Py can be uninstalled with the commands below.

pip uninstall chartfactor
pip uninstall chartfactor-jlab-ext

Installing on Kaggle

Kaggle is a platform that offers a no-setup, customizable, Jupyter Notebooks environment. Follow the steps below to use Chartfactor Py on Kaggle.

Enabling internet connections

Note

Skip this section if you have previously installed packages in Kaggle

If you are using Kaggle for the first time, you may experience connection issues when installing the Chartfactor Py package. In order to solve this problem, perform the following steps before proceeding with the installation of the package.

1. Register a new account on Kaggle and then log in

2. Next, create or open the notebook in which you want to install Chartfactor Py and click the Toggle sidebar visibility icon on the top right

   

3. Once the sidebar is open, go to the Settings section, and enable internet connections by toggling the status button to the right

   

Installing via pip

Once you have internet connections enabled, choose a cell, and run the following command:

!pip install chartfactor

After the installation finishes, run the following python command in a new cell to import the chartfactor library:

from chartfactor import *

You can check the installed version of Chartfactor Py to verify that the installation was successful:

cf.version()

You are now ready to leverage ChartFactor Py to accomplish your data analytics needs on your Pandas DataFrames.

Installation demo