crosscompute


Namecrosscompute JSON
Version 0.9.4.9 PyPI version JSON
download
home_pagehttps://crosscompute.com
SummaryAutomate your Jupyter notebooks and scripts as tools, reports, dashboards.
upload_time2023-05-20 03:29:11
maintainer
docs_urlNone
authorCrossCompute Inc.
requires_python>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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](https://docs.crosscompute.com).

- 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:

- [jupyterlab-crosscompute](https://github.com/crosscompute/jupyterlab-crosscompute)
- [crosscompute-views-map](https://github.com/crosscompute/crosscompute-views-map)
- [crosscompute-views-barcode](https://github.com/crosscompute/crosscompute-views-barcode)
- [crosscompute-printers-pdf](https://github.com/crosscompute/crosscompute-printers-pdf)

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](https://github.com/crosscompute/crosscompute/blob/develop/crosscompute/templates/configuration.yaml).

## Usage

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

# Initialize configuration
crosscompute

# Serve automation
crosscompute automate.yml
```

Here are some examples and tutorials:

- [Gallery](https://crosscompute.net) [[source](https://github.com/crosscompute/crosscompute-examples)]
- [Documentation](https://docs.crosscompute.com) [[source](https://github.com/crosscompute/crosscompute-docs)]
- [Forum](https://forum.crosscompute.com)

## Development

```bash
# 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.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

- [Kashfi Fahim](https://www.linkedin.com/in/kashfifahim)
- [Olga Ryabtseva](https://www.linkedin.com/in/olga-creutzburg)
- [Salah Ahmed](https://www.linkedin.com/in/salahspage)
- [Rodrigo Guarachi](https://www.linkedin.com/in/rmguarachi)
- [Polina Chernomaz](https://www.linkedin.com/in/polinac)
- [Miguel Ángel Gordián](https://www.linkedin.com/in/miguelgordian)
- [Noé Domínguez Porras](https://www.linkedin.com/in/noedominguez)
- [Marta Moreno](https://www.linkedin.com/in/marta-moreno-07364b82)
- [Ning Wei](https://www.linkedin.com/in/ning-wei-8152393b)
- [Elaine Chan](https://www.linkedin.com/in/chanelaine)
- [Aida Shoydokova](https://www.linkedin.com/in/ashoydok)
- [Jennifer Ruda](https://www.linkedin.com/in/jruda)

            

Raw data

            {
    "_id": null,
    "home_page": "https://crosscompute.com",
    "name": "crosscompute",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "",
    "author": "CrossCompute Inc.",
    "author_email": "support@crosscompute.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/6b/76b623828c08bad0f8b9f610453656bea206e68fa627e8a9ce08af87a7a3/crosscompute-0.9.4.9.tar.gz",
    "platform": "any",
    "description": "# CrossCompute Analytics Automation Framework\n\nAutomate 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](https://docs.crosscompute.com).\n\n- Reports are documents that update when the data changes.\n- Forms are step-by-step questions that generate a specific web-based report.\n- Tools are forms that transform input variables into output variables.\n- Widgets are interactive visualizations that update when the data changes.\n- Dashboards are widgets in a layout.\n\nHere are some available extensions:\n\n- [jupyterlab-crosscompute](https://github.com/crosscompute/jupyterlab-crosscompute)\n- [crosscompute-views-map](https://github.com/crosscompute/crosscompute-views-map)\n- [crosscompute-views-barcode](https://github.com/crosscompute/crosscompute-views-barcode)\n- [crosscompute-printers-pdf](https://github.com/crosscompute/crosscompute-printers-pdf)\n\nHere are some available views:\n\n- link\n- string\n- number\n- password\n- email\n- text\n- markdown\n- image\n- radio\n- checkbox\n- table\n- frame\n- json\n- pdf\n- file\n- map-mapbox (crosscompute-views-map)\n- map-mapbox-location (crosscompute-views-map)\n- map-deck-screengrid (crosscompute-views-map)\n- barcode (crosscompute-views-barcode)\n\n[Here are the currently supported configuration options](https://github.com/crosscompute/crosscompute/blob/develop/crosscompute/templates/configuration.yaml).\n\n## Usage\n\n```bash\n# Upgrade package\npip install crosscompute>=0.9.4 --upgrade\n\n# Initialize configuration\ncrosscompute\n\n# Serve automation\ncrosscompute automate.yml\n```\n\nHere are some examples and tutorials:\n\n- [Gallery](https://crosscompute.net) [[source](https://github.com/crosscompute/crosscompute-examples)]\n- [Documentation](https://docs.crosscompute.com) [[source](https://github.com/crosscompute/crosscompute-docs)]\n- [Forum](https://forum.crosscompute.com)\n\n## Development\n\n```bash\n# Clone repository\ngit clone https://github.com/crosscompute/crosscompute\n\n# Install with dependencies for tests\ncd crosscompute\npip install -e .[test]\n\n# Run tests\npytest --cov=crosscompute --cov-report term-missing:skip-covered tests\n\n# Build package for PyPI\npip install build\npython -m build --sdist --wheel\n\n# Publish package on PyPI\npip install twine --upgrade\npython -m twine upload dist/*\n```\n\n## Troubleshooting\n\n### SyntaxError: Invalid Syntax\n\nIf you get the following error, you are running on an older version of Python:\n\n```\n$ crosscompute\n\n    while chunk := f.read(CHUNK_SIZE_IN_BYTES):\n                 ^\nSyntaxError: invalid syntax\n```\n\nTo solve this issue, create a virtual environment using python >= 3.10.\n\n```\nsudo dnf -y install python3.10\n# sudo apt -y install python3.10\n\npython3.10 -m venv ~/.virtualenvs/crosscompute\nsource ~/.virtualenvs/crosscompute/bin/activate\n\npip install crosscompute>=0.9.4\n```\n\n## Acknowledgments\n\n- [Kashfi Fahim](https://www.linkedin.com/in/kashfifahim)\n- [Olga Ryabtseva](https://www.linkedin.com/in/olga-creutzburg)\n- [Salah Ahmed](https://www.linkedin.com/in/salahspage)\n- [Rodrigo Guarachi](https://www.linkedin.com/in/rmguarachi)\n- [Polina Chernomaz](https://www.linkedin.com/in/polinac)\n- [Miguel \u00c1ngel Gordi\u00e1n](https://www.linkedin.com/in/miguelgordian)\n- [No\u00e9 Dom\u00ednguez Porras](https://www.linkedin.com/in/noedominguez)\n- [Marta Moreno](https://www.linkedin.com/in/marta-moreno-07364b82)\n- [Ning Wei](https://www.linkedin.com/in/ning-wei-8152393b)\n- [Elaine Chan](https://www.linkedin.com/in/chanelaine)\n- [Aida Shoydokova](https://www.linkedin.com/in/ashoydok)\n- [Jennifer Ruda](https://www.linkedin.com/in/jruda)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Automate your Jupyter notebooks and scripts as tools, reports, dashboards.",
    "version": "0.9.4.9",
    "project_urls": {
        "Bug Tracker": "https://github.com/crosscompute/crosscompute/issues",
        "Documentation": "https://docs.crosscompute.com",
        "Homepage": "https://crosscompute.com",
        "Source Code": "https://github.com/crosscompute/crosscompute"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b17f6bd9652553f33005507c5f888c37803d131062bf56a4fa20bb3b35bc5ad3",
                "md5": "c4effc0517d534745f392d05a02b76cf",
                "sha256": "701ce4c045a25009397b386e6e7607a3d60dbe2c84c108214578fde4697fdc09"
            },
            "downloads": -1,
            "filename": "crosscompute-0.9.4.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c4effc0517d534745f392d05a02b76cf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 93825,
            "upload_time": "2023-05-20T03:29:09",
            "upload_time_iso_8601": "2023-05-20T03:29:09.107660Z",
            "url": "https://files.pythonhosted.org/packages/b1/7f/6bd9652553f33005507c5f888c37803d131062bf56a4fa20bb3b35bc5ad3/crosscompute-0.9.4.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e6b76b623828c08bad0f8b9f610453656bea206e68fa627e8a9ce08af87a7a3",
                "md5": "f939b9024315159f3890fed000483a4f",
                "sha256": "4c6b2e6e4d95fd06183be259ea85733e1daeae37defd49f8d68d3472032e9dd4"
            },
            "downloads": -1,
            "filename": "crosscompute-0.9.4.9.tar.gz",
            "has_sig": false,
            "md5_digest": "f939b9024315159f3890fed000483a4f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 76058,
            "upload_time": "2023-05-20T03:29:11",
            "upload_time_iso_8601": "2023-05-20T03:29:11.115416Z",
            "url": "https://files.pythonhosted.org/packages/5e/6b/76b623828c08bad0f8b9f610453656bea206e68fa627e8a9ce08af87a7a3/crosscompute-0.9.4.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-20 03:29:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "crosscompute",
    "github_project": "crosscompute",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "crosscompute"
}
        
Elapsed time: 0.06872s