Skip to main content

Automate your Jupyter notebooks and scripts as tools, reports, dashboards.

Project description

CrossCompute Analytics Automation Framework

Automate your Jupyter notebooks and scripts as web-based reports, tools, widgets, dashboards, forms. Use this framework to create your own automations, then serve locally or deploy on your own instance of the CrossCompute Analytics Automation System.

  • Reports are documents that update when the data changes.
  • Forms are step-by-step questions that generate a specific web-based report.
  • Tools are forms that transform input variables into output variables.
  • Widgets are interactive visualizations that update when the data changes.
  • Dashboards are widgets in a layout.

Here are some available extensions:

Here are some available views:

  • link
  • string
  • number
  • password
  • email
  • text
  • markdown
  • image
  • radio
  • checkbox
  • table
  • frame
  • json
  • pdf
  • file
  • map-mapbox (crosscompute-views-map)
  • map-mapbox-location (crosscompute-views-map)
  • map-deck-screengrid (crosscompute-views-map)
  • barcode (crosscompute-views-barcode)

Here are the currently supported configuration options.

Usage

# Upgrade package
pip install crosscompute>=0.9.4 --upgrade

# Initialize configuration
crosscompute

# Serve automation
crosscompute automate.yml

Here are some examples and tutorials:

Development

# Clone repository
git clone https://github.com/crosscompute/crosscompute

# Install with dependencies for tests
cd crosscompute
pip install -e .[test]

# Run tests
pytest --cov=crosscompute --cov-report term-missing:skip-covered -n auto tests

# Build package for PyPI
pip install build
python -m build --sdist --wheel

# Publish package on PyPI
pip install twine --upgrade
python -m twine upload dist/*

Troubleshooting

SyntaxError: Invalid Syntax

If you get the following error, you are running on an older version of Python:

$ crosscompute

    while chunk := f.read(CHUNK_SIZE_IN_BYTES):
                 ^
SyntaxError: invalid syntax

To solve this issue, create a virtual environment using python >= 3.10.

sudo dnf -y install python3.10
# sudo apt -y install python3.10

python3.10 -m venv ~/.virtualenvs/crosscompute
source ~/.virtualenvs/crosscompute/bin/activate

pip install crosscompute>=0.9.4

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crosscompute-0.9.4.13.tar.gz (78.6 kB view details)

Uploaded Source

Built Distribution

crosscompute-0.9.4.13-py3-none-any.whl (96.8 kB view details)

Uploaded Python 3

File details

Details for the file crosscompute-0.9.4.13.tar.gz.

File metadata

  • Download URL: crosscompute-0.9.4.13.tar.gz
  • Upload date:
  • Size: 78.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for crosscompute-0.9.4.13.tar.gz
Algorithm Hash digest
SHA256 dc885deccc8fef454617acefd6e49d749fa0b6ae5742d6035ae808ed5311b50d
MD5 5f5d53a34856cda5449ff5ec275f49ac
BLAKE2b-256 99a7299b431585565eaadbba3ce695e28581f901db8234fb73b297f2ba251e63

See more details on using hashes here.

File details

Details for the file crosscompute-0.9.4.13-py3-none-any.whl.

File metadata

File hashes

Hashes for crosscompute-0.9.4.13-py3-none-any.whl
Algorithm Hash digest
SHA256 afb1c024f5748014896d77f4fcc0f74c58fddd7290f4eb3efeb3e3ddb9715bcf
MD5 e017f5f42092e2dc5d3db0cadc9fc97d
BLAKE2b-256 c2fe52a8703be37c6f55b7715f35b4323ddcf841326486aec70f8c7e49860e87

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page