Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #35

Merged
merged 2 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,38 @@ and examples that are available. To run tests:
There are several examples available that demonstrate how to make use of the Pipeline API in isolation. These are described in the table below.
If you want examples that demonstrate how to use 51Degrees products such as device detection, then these are available in the corresponding [repository](https://github.com/51Degrees/device-detection-python) and on our [website](http://51degrees.com/documentation/_examples__device_detection__index.html).

| Example | Description |
| fiftyone_pipeline_code/examples/client_side_evidence_custom_flow_element.py | Demonstrates how to create a custom flow element, which can then be included in a pipeline. |
| fiftyone_pipeline_engines_fiftyone/examples/usagesharing | Shows how to share usage with 51Degrees. This helps us to keep our products up to date and accurate. |
| Example | Description |
|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| fiftyone_pipeline_code/examples/client_side_evidence_custom_flow_element.py | Demonstrates how to create a custom flow element, which can then be included in a pipeline. |
| fiftyone_pipeline_engines_fiftyone/examples/usagesharing | Shows how to share usage with 51Degrees. This helps us to keep our products up to date and accurate. |

To run the custom flow element example, you will need to use flask:
### Linux

Execute `export FLASK_APP=client_side_evidence_custom_flow_element.py`, then start your application with `flask run`.
Install packages
```shell
pwsh ./setup.ps1
```
Set path to the script
```sh
export FLASK_APP=client_side_evidence_custom_flow_element.py
```
then start your application with
```sh
flask run
```

### Windows

Execute `$env:FLASK_APP = "client_side_evidence_custom_flow_element.py"`, then start your application with `flask run`.
Install packages
```shell
pwsh ./setup.ps1
```
Set path to the script
```pwsh
$env:FLASK_APP = "client_side_evidence_custom_flow_element.py"
```
then start your application with
```pwsh
flask run
```
5 changes: 5 additions & 0 deletions setup.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
python -m pip install -e fiftyone_pipeline_cloudrequestengine/
python -m pip install -e fiftyone_pipeline_core/
python -m pip install -e fiftyone_pipeline_engines/
python -m pip install -e fiftyone_pipeline_engines_fiftyone/
python -m pip install flask
Loading