Skip to content

Latest commit

 

History

History
100 lines (74 loc) · 2.46 KB

README.md

File metadata and controls

100 lines (74 loc) · 2.46 KB
Raw

CrossCompute Examples

Here are example reports, forms, tools, widgets, dashboards made using the CrossCompute Analytics Automation Framework.

Usage

cd ~/Projects
git clone https://github.com/crosscompute/crosscompute-examples --recursive
cd crosscompute-examples
git submodule init
git submodule update

Try via Podman

cd ~/Projects/crosscompute-examples
podman build . -t crosscompute-examples
podman run -it -p 7000:7000 crosscompute-examples

If you want to try the examples that require environment variables, use the following commands:

vim YOUR-ENV-FILE
    MAPBOX_TOKEN=YOUR-MAPBOX-TOKEN
    GOOGLE_KEY=YOUR-GOOGLE-KEY
    ATTACHMENTS_FOLDER=~/Documents/attachments

podman run -it --env-file YOUR-ENV-FILE -p 7000:7000 crosscompute-examples

Try via JupyterLab

pip install --upgrade \
    jupyterlab-crosscompute>=0.2.2
find . -name setup.sh -exec bash '{}' ';'

jupyter lab

If you want to try the examples that require environment variables, use the following commands:

pip install --upgrade \
    crosscompute-views-map>=0.1.2
find . -name setup.sh -exec bash '{}' ';'

# Configure environment for reports/map-schools
export MAPBOX_TOKEN=YOUR-MAPBOX-TOKEN
# Configure environment for tools/find-places
export GOOGLE_KEY=YOUR-GOOGLE-KEY
# Configure environment for tools/send-emails
export ATTACHMENTS_FOLDER=~/Documents/attachments

jupyter lab

CrossCompute Extensions for JupyterLab

Try via Command Line

pip install --upgrade \
    crosscompute>=0.9.2
find . -name setup.sh -exec bash '{}' ';'

crosscompute

If you want to try the examples that require environment variables, use the following commands:

pip install --upgrade \
    crosscompute-views-map>=0.1.2
find . -name setup.sh -exec bash '{}' ';'

# Configure environment for reports/map-schools
export MAPBOX_TOKEN=YOUR-MAPBOX-TOKEN
# Configure environment for tools/find-places
export GOOGLE_KEY=YOUR-GOOGLE-KEY
# Configure environment for tools/send-emails
export ATTACHMENTS_FOLDER=~/Documents/attachments

crosscompute automate-plus.yml

Development

# Install pre-commit hooks
pip install pre-commit
pre-commit install