Skip to main content

Continuous Integration Continuous Deployment Coverage Status

Workflow

Workflow is a Python-based system designed to manage and automate any task in a structured manner. It provides a framework for defining (work), scheduling (buckets), sequencing (pipelines), executing (managers) and archiving (results) the output of any task. The system is designed to be modular with a low threshold of entry for new users, while also providing advanced features for power users.

For more information, please refer to the Workflow documentation.

Getting Started

To get started with the Workflow, you need to have Python 3.8.1 or later installed. You can then install the project's dependencies using Poetry:

Install from PyPI

pip install workflow.core

Install from Source

pip install git+https://github.com/chimefrb/workflow.git

Alternatively, you can add the Workflow project as a dependency to your own project using Poetry:

poetry add git+https://github.com/chimefrb/workflow.git

Contributing

Contributions to the Workflow project are welcome. Please ensure that any changes you make pass the project's tests and adhere to the project's coding standards.

Setting Up Your Development Environment

git clone https://github.com/chimefrb/workflow.git
cd workflow
poetry install
pre-commit install

Writing Your First Commit

git add file/you/changed.py
poetry run commitizen commit

Running Tests

You can run the project's tests using Docker & Poetry:

docker compose up -d
poetry run pytest

License

Workflow is licensed under the MIT license.

Copyright (c) 2024 CHIME/FRB Collaboration

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Metadata

Release files for workflow.core 1.12.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for workflow.core 1.12.3
File Size Uploaded
workflow_core-1.12.3.tar.gz 49.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for workflow.core 1.12.3
File Interpreter ABI Platform
workflow_core-1.12.3-py3-none-any.whl Python 3 none any Details

Total release size: 123.0 kB

Release files / workflow_core-1.12.3.tar.gz

Download URL workflow_core-1.12.3.tar.gz
Size 49.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3e5da35e47f85202c4d9607312cf8a6d6e5509d2430c32b44feccbec26d9791f
BLAKE2b-256 checksum
How to use checksums
81bde09899a5d0adb631dbfee75df3f072512fd1668d355e01d78bb342d28f4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure

Release files / workflow_core-1.12.3-py3-none-any.whl

Download URL workflow_core-1.12.3-py3-none-any.whl
Size 73.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8a5d6497537c729cf8b8b68d9bde224f087932d8069bf9594ee0ec732cbf33ac
BLAKE2b-256 checksum
How to use checksums
ef5b21a7a0f4e06f05908fe0b06e7187f174c561cada70c11a0b497aadf02076
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure

Release history Release notifications | RSS feed

This release

1.12.3 This release

2 release files

1.12.0

2 release files

1.11.6

2 release files

1.11.3

2 release files

1.11.2

2 release files

1.11.1

2 release files

1.11.0

2 release files

1.10.0

2 release files

1.9.10

2 release files

1.9.9

2 release files

1.9.8

2 release files

1.9.7

2 release files

1.9.6

2 release files

1.9.5

2 release files

1.9.4

2 release files

1.9.3

2 release files

1.9.2

2 release files

1.9.1

2 release files

1.9.0

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.0

2 release files

1.4.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page