Automate your Jupyter notebooks and scripts as web-based reports, forms, tools, widgets, 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
- text
- markdown
- image
- table
- map-mapbox (crosscompute-views-map)
- map-deck-screengrid (crosscompute-views-map)
Here are the currently supported configuration options.
Usage
# Upgrade package
pip install crosscompute>=0.9.2 --upgrade
# Initialize configuration
crosscompute
# Serve automation
crosscompute automate.yml
Here are some tutorials and examples:
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 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.9.
sudo dnf -y install python3.9
# sudo apt -y install python3.9
python3.9 -m venv ~/.virtualenvs/crosscompute
source ~/.virtualenvs/crosscompute/bin/activate
pip install crosscompute>=0.9.2
Acknowledgments
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 crosscompute-0.9.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb3ec18e5fec9f03c2bf145467e32d232f0e6255f9cc89cc270154e81d3eecf4 |
|
MD5 | 0240ff05089f94f5aa91ba5575a4fb32 |
|
BLAKE2b-256 | 41bf0abda4eefc984f6a586fc7c584a487f28556ecd8e3ebc45f034290640eb9 |