Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boomerang-io/worker.python
Python based worker, useful in the flow tasks
https://github.com/boomerang-io/worker.python
Last synced: about 7 hours ago
JSON representation
Python based worker, useful in the flow tasks
- Host: GitHub
- URL: https://github.com/boomerang-io/worker.python
- Owner: boomerang-io
- License: apache-2.0
- Created: 2021-06-07T16:02:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T03:16:28.000Z (over 2 years ago)
- Last Synced: 2023-03-03T20:13:01.314Z (over 1 year ago)
- Language: Python
- Size: 54.7 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Flow Worker
## Table of Contents
- [Python Flow Worker](#python-flow-worker)
- [Table of Contents](#table-of-contents)
- [Design](#design)
- [Develop](#develop)
- [How to run in a virtual environment with Python (Recommended)](#how-to-run-in-a-virtual-environment-with-python-recommended)
- [Prerequisites for virtual environment](#prerequisites-for-virtual-environment)
- [Steps to run in virtual environment](#steps-to-run-in-virtual-environment)
- [How to run locally with Python](#how-to-run-locally-with-python)
- [Prerequisites for local environment](#prerequisites-for-local-environment)
- [Steps to run in local environment](#steps-to-run-in-local-environment)
- [Test](#test)
- [Package](#package)
- [Through IBM Services Essentials CICD](#through-ibm-services-essentials-cicd)
- [Manual packaging](#manual-packaging)
- [Licence](#licence)
## Design
TBD
## Develop
### How to run in a virtual environment with Python (Recommended)
#### Prerequisites for virtual environment
- Python 3.6 or higher
- Pip 19.0 or higher
#### Steps to run in virtual environment
1. Create a virtual environment. To create a new virtual environment, decide upon a directory where you want to place it, and run the `venv` module as a script with the directory path. We recommend naming directory `.venv`, since it is also ignored by git through `.gitignore` rules.
```sh
python3 -m venv .venv
```
2. Once you’ve created a virtual environment, you may activate it.
```sh
source .venv/bin/activate
```
3. After activating the virtual environment, you can run the `pyworker` module.
```sh
python3 -m pyworker
```
4. To leave the virtual environment, simply deactivate it.
```sh
deactivate
```
5. You may also want to delete the created virtual environment to free up space on your disk.
```sh
rm -r .venv
```
### How to run locally with Python
#### Prerequisites for local environment
- Python 3.6 or higher
#### Steps to run in local environment
1. Run the `pyworker` module.
```sh
python3 -m pyworker
```
## Test
TBD
## Package
### Through IBM Services Essentials CICD
**Note:** In order to use CICD tool of IBM Services Essentials platform, you must be a member of a team, have CICD service added and approved for the same team, configure a new CICD component to build and deploy from this repository. See more in the [docs][2].
To start a new build and/or deploy activity in CICD, create a new tag trigger, then create and push a new tag in your repository.
1. Create a new git tag matching the CICD trigger regular expression.
2. Push the created git tag to the remote.
3. Check the activity screen in IBM Services Essentials CICD.
### Manual packaging
Build a new Docker image.
```sh
docker build --tag worker-python:0.0.1 .
```
## Licence
[Apache License 2.0][1]
[1]: https://github.com/corcoja/worker.python/blob/main/LICENSE
[2]: https://servicesessentials.ibm.com/docs/boomerang-cicd/8.1.0/introduction/overview