{"id":30883265,"url":"https://github.com/globocom/auror-core","last_synced_at":"2025-10-10T12:17:44.755Z","repository":{"id":66161161,"uuid":"158747739","full_name":"globocom/auror-core","owner":"globocom","description":"Azkaban Auror core for flow creation","archived":false,"fork":false,"pushed_at":"2020-10-06T13:08:23.000Z","size":94,"stargazers_count":10,"open_issues_count":2,"forks_count":7,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-09-25T04:59:52.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/globocom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-22T20:33:42.000Z","updated_at":"2023-10-13T04:35:04.000Z","dependencies_parsed_at":"2023-03-10T23:41:47.931Z","dependency_job_id":null,"html_url":"https://github.com/globocom/auror-core","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/globocom/auror-core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globocom%2Fauror-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globocom%2Fauror-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globocom%2Fauror-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globocom%2Fauror-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/globocom","download_url":"https://codeload.github.com/globocom/auror-core/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globocom%2Fauror-core/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279003898,"owners_count":26083639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-08T09:43:59.221Z","updated_at":"2025-10-10T12:17:44.750Z","avatar_url":"https://github.com/globocom.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/globocom/auror-core.svg?branch=master)](https://travis-ci.com/globocom/auror-core)\n\n# Auror Core\n\u003e Simple Flow creation for Azkaban\n\n![auror](https://images.unsplash.com/photo-1594399432263-78cfdbb29460?ixlib=rb-1.2.1\u0026ixid=eyJhcHBfaWQiOjEyMDd9\u0026auto=format\u0026fit=crop\u0026w=640\u0026q=80)\n\n\u003cspan\u003ePhoto by \u003ca href=\"https://unsplash.com/@rhii?utm_source=unsplash\u0026amp;utm_medium=referral\u0026amp;utm_content=creditCopyText\"\u003eRhii Photography\u003c/a\u003e on \u003ca href=\"https://unsplash.com/?utm_source=unsplash\u0026amp;utm_medium=referral\u0026amp;utm_content=creditCopyText\"\u003eUnsplash\u003c/a\u003e\u003c/span\u003e\n\n- [Auror Core](#auror-core)\n  - [Install](#install)\n  - [Supported Job Types](#supported-job-types)\n    - [V1](#v1)\n    - [V2](#v2)\n  - [Usage](#usage)\n    - [Creating a simple Azkaban flow with one command](#creating-a-simple-azkaban-flow-with-one-command)\n    - [Creating a simple V2 Azkaban flow with one command](#creating-a-simple-v2-azkaban-flow-with-one-command)\n    - [Creating Flows with dependencies](#creating-flows-with-dependencies)\n    - [Sharing job attributes](#sharing-job-attributes)\n    - [Job with extra customization and configuration](#job-with-extra-customization-and-configuration)\n    - [Integrating with Flow (just for V1)](#integrating-with-flow-just-for-v1)\n    - [Using Flow Params](#using-flow-params)\n    - [Using Flow Environment Variables](#using-flow-environment-variables)\n    - [Using Flow Environment Variables and Params](#using-flow-environment-variables-and-params)\n    - [Join multiple variables in one](#join-multiple-variables-in-one)\n    - [Load jobs from YAML File (just for V2)](#load-jobs-from-yaml-file-just-for-v2)\n    - [Dump memory flows to a Python File (just for V2)](#dump-memory-flows-to-a-python-file-just-for-v2)\n  - [Plugins](#plugins)\n  - [Contribute](#contribute)\n\n## Install\n\n```bash\npip install auror_core\n```\n\n## Supported Job Types\n\n### V1\n\n* **Command**\n* **Flow**\n\n### V2\n\n* **Command**\n\n## Usage\n\n### Creating a simple Azkaban flow with one command \n\nYou just need to import job type and project\n\n```python\nfrom auror_core.v1.job import Job, Command\nfrom auror_core import Project\n\ncom1 = Job()\\\n.as_type(Command)\\\n.with_name(\"commands job\")\\\n.with_command(\"bash echo 1\")\\\n.with_another_command(\"bash echo 2\")\n\nProject(\"folder_to_generate_files\", com1).write()\n\n```\n\n### Creating a simple V2 Azkaban flow with one command \n\nV2 flow is implemented under v2 subfolder with same job types\n\n```python\nfrom auror_core.v2.job import Job, Command\nfrom auror_core import Project\n\ncom1 = Job()\\\n.as_type(Command)\\\n.with_name(\"commands job\")\\\n.with_command(\"bash echo 1\")\\\n.with_another_command(\"bash echo 2\")\n\nProject(\"folder_to_generate_files\", com1).is_v2().write()\n\n```\n\n### Creating Flows with dependencies\n\n```python\nfrom auror_core.v2.job import Job, Command\nfrom auror_core import Project\n\ncom1 = Job()\\\n.as_type(Command)\\\n.with_name(\"commands job\")\\\n.with_command(\"bash echo 1\")\\\n.with_another_command(\"bash echo 2\")\n\ncom2 = Command()\\\n.with_name(\"sub command job\")\\\n.with_command(\"bash echo 1\")\\\n.with_dependencies(com1)\n\nProject(\"folder_to_generate_files\", com1, com2).is_v2().write()\n\n```\n\n### Sharing job attributes\n\nOrganize jobs with same configuration\n\n```python\nfrom auror_core.v2.job import Command\nfrom auror_core import Project\n\ncom = Command()\\\n.with_command(\"bash echo 1\")\n\ncom1 = com.with_name(\"commands job\")\\\n.with_another_command(\"bash echo 2\")\n\ncom2 = com.with_name(\"sub command job\")\\\n.with_dependencies(com1)\n\nProject(\"folder_to_generate_files\", com1, com2).is_v2().write()\n\n```\n\n### Job with extra customization and configuration \n\nSimulating a Command with base Job (NOT RECOMMENDED)\n\n```python\nfrom auror_core.v1.job import Job\nfrom auror_core import Project\n\ncom1 = Job()\\\n.with_name(\"commands job\")\\\n.with_(command=\"bash echo 1\")\n\ncom1._type = \"command\"\n\nProject(\"folder_to_generate_files\", com1).write()\n\n```\n\n### Integrating with Flow (just for V1)\n\nV2 already have flow included\n\n```python\nfrom auror_core.v1.job import Command, Flow, Job\nfrom auror_core import Project\n\ncom1 = Command()\\\n.with_name(\"commands job\")\\\n.with_command(\"bash echo 1\")\n\nflow = Job()\\\n.as_type(Flow)\\\n.with_name(\"flow\")\\\n.with_dependencies(com1)\n\nProject(\"folder_to_generate_files\", com1, flow).write()\n\n```\n\n### Using Flow Params\n\n```python\nfrom auror_core.v2.job import Command\nfrom auror_core.v2.params import Params\nfrom auror_core import Project\n\nparams = Params(\n    teste1=\"my test\",\n    variable=\"my variable\"\n)\n\ncom = Command()\\\n.with_command(\"bash echo ${variable}\")\n\nProject(\"folder_to_generate_files\", com)\\\n.is_v2()\\\n.with_params(params)\\\n.write()\n\n```\n\n### Using Flow Environment Variables\n\n\n```python\nfrom auror_core.v2.job import Command\nfrom auror_core.v2.params import Env\nfrom auror_core import Project\n\nenv = Env(\n    TESTE=\"my test\",\n    VARIABLE=\"my variable\"\n)\n\ncom = Command()\\\n.with_command(\"bash echo $VARIABLE\")\n\nProject(\"folder_to_generate_files\", com)\\\n.is_v2()\\\n.with_params(env)\\\n.write()\n\n```\n\n### Using Flow Environment Variables and Params\n\n\n```python\nfrom auror_core.v2.job import Command\nfrom auror_core.v2.params import Env, Params\nfrom auror_core import Project\n\nenv = Env(\n    TESTE=\"my test\",\n    VARIABLE=\"my variable\"\n)\n\nparams = Params(\n    teste1=\"my test\",\n    variable=\"my variable\"\n)\n\ncom = Command()\\\n.with_command(\"bash echo $VARIABLE ${variable}\")\n\nProject(\"folder_to_generate_files\", com)\\\n.is_v2()\\\n.with_params(params, env)\\\n.write()\n\n```\n\n### Join multiple variables in one\n\n```python\nfrom auror_core.v2.job import Command\nfrom auror_core.v2.params import Env\nfrom auror_core import Project\n\nenv = Env(\n    TESTE=\"env test\",\n    VARIABLE=\"env variable\"\n)\n\nparams = Params(\n    teste1=\"my test\",\n    variable=\"my variable\"\n)\n\none_param = ParamsJoin(\"params_strange_name\", \",\") ## param name and separator\n\ncom = Command()\\\n.with_command(\"bash echo ${params_strange_name}\") \n## it will print: my test,my variable,env test,env variable\n## THERE IS NO ORDER GUARANTEE, JUST Python 3.6 \u003e\n\nProject(\"folder_to_generate_files\", com)\\\n.is_v2()\\\n.with_params(one_param(params, env))\\\n.write()\n\n```\n\n### Load jobs from YAML File (just for V2)\n\n**You can find some YAML File examples on [Azkaban Flow Documentation](https://github.com/azkaban/azkaban/wiki/Azkaban-Flow-2.0-Design#flow-yaml-file)**\n\n```python\nfrom auror_core.v2.loader import Loader\n\nloader = Loader('/path/to/file/flow.yaml')\njobs = loader.as_job_objects()\n```\n\nOr you can export these jobs as a Python File\n\n```python\nfrom auror_core.v2.loader import Loader\n\nloader = Loader('/path/to/file/flow.yaml')\njobs = loader.as_python_file('/path/to/desired/directory') # will be dumped with 'flow.py' name\n```\n\n### Dump memory flows to a Python File (just for V2)\n\n```python\nfrom auror_core.v2.dumper import Dumper\n\ncom1 = Job() \\\n.with_name(\"commands job 1\") \\\n.with_(command=\"bash echo 1\")\n\ncom2 = Job()\\\n.with_name(\"commands job 2\")\\\n.with_(command=\"bash echo 2\")\n\ndumper = Dumper('/path/to/desired/directory') # will be dumped with 'flow.py' name\ndumper.dump_jobs(com1, com2)\n```\n\n## Plugins\n\nPlugins are just extensions from auror_core\n\nThere is a cookiecutter for new azkaban jobtypes with Auror template too: https://github.com/globocom/azkaban-jobtype-cookiecutter\n\nWe already have email plugin: https://github.com/globocom/azkaban-jobtype-email\n\n## Contribute\n\nFor development and contributing, please follow [Contributing Guide](https://github.com/globocom/auror-core/blob/master/CONTRIBUTING.md) and ALWAYS respect the [Code of Conduct](https://github.com/globocom/auror-core/blob/master/CODE_OF_CONDUCT.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobocom%2Fauror-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglobocom%2Fauror-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobocom%2Fauror-core/lists"}