Metadata-Version: 2.1
Name: scientiflow-cli
Version: 0.3.2
Summary: CLI tool for scientiflow. This application runs on the client side, decodes pipelines, and executes them in the configured order!
License: Proprietary
Author: ScientiFlow
Author-email: scientiflow@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: art (>=6.5,<7.0)
Requires-Dist: cryptography (>=43.0.1,<44.0.0)
Requires-Dist: pwinput (>=1.0.3,<2.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: rich (>=14.0.0,<15.0.0)
Description-Content-Type: text/markdown

# Scientiflow

## Setting the ENV variables

```
# When developing on Windows, run:
$env:API_BASE="SCIENTIFLOW_BACKEND_URL"     # Set the base URL of the Scientiflow backend
$env:AUTH_TOKEN="SOME_AUTH_TOKEN"           # Set the AUTH token that you get after logging in
$env:SCFLOW_DEBUG=1                         # Run in debug mode, using some dummy data

# on Linux, run:
export API_BASE="SCIENTIFLOW_BACKEND_URL"   # Set the base URL of the Scientiflow backend
export AUTH_TOKEN="SOME_AUTH_TOKEN"         # Set the AUTH token that you get after logging in
export SCFLOW_DEBUG=1                       # Run in debug mode, using some dummy data
```

## Building and installing the python package

```bash
poetry build
pip install dist/scientiflow_cli-0.1.0-py3-none-any.whl --force-reinstall

# Now you can run it as:
python -m scientiflow_cli --help
```

> Note: The `--force-reinstall` flag is used as a sage-guard, in case an already exising version of the package is installed.

## For the devs

> Note
> If you need to add a dependency, which this project depends on, use the command `poetry add` instead of doing a pip install. This will ensure that the `pyproject.toml` file is updated with the new dependency, and all the other devs have the same dependencies and dependencies versions.

```bash
# Activate a poetry shell, and install dependencies
poetry shell

# Install the dependencies if it's your first time working on the project, using:
# poetry install
```

```bash
# In order to run the package without building, you can do:
poetry run python -m scientiflow_cli.main --help
```

