zrb 0.0.50__py3-none-any.whl → 0.0.52__py3-none-any.whl

zrb-0.0.50.dist-info/METADATA

@@ -1,450 +0,0 @@
-Metadata-Version: 2.1
-Name: zrb
-Version: 0.0.50
-Summary: Your faithful companion
-Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Dist: click==8.1.3
-Requires-Dist: aiofiles==23.1.0
-Requires-Dist: typeguard==2.13.3
-Requires-Dist: termcolor==2.2.0
-Requires-Dist: Jinja2==3.1.2
-Requires-Dist: libcst==0.4.9
-Requires-Dist: python-dotenv==0.21.1
-Requires-Dist: jsons==1.6.3
-Requires-Dist: ruamel.yaml==0.17.21
-Requires-Dist: setuptools==49.2.1
-Requires-Dist: autopep8==2.0.1
-Requires-Dist: flake8==6.0.0 ; extra == "dev"
-Requires-Dist: pytest==7.2.1 ; extra == "test"
-Requires-Dist: pytest-cov==4.0.0 ; extra == "test"
-Requires-Dist: pytest-xdist==3.2.0 ; extra == "test"
-Requires-Dist: pytest-asyncio==0.21.0 ; extra == "test"
-Project-URL: Bug Tracker, https://github.com/state-alchemists/zaruba/issues
-Project-URL: Homepage, https://github.com/state-alchemists/zaruba
-Provides-Extra: dev
-Provides-Extra: test
-
-# Zrb (WIP)
-
-Your faithful companion.
-
-# How to install
-
-```bash
-pip install zrb
-```
-
-# How to use
-
-To run a task, you can invoke the following command:
-
-```bash
-zrb <task> [arguments]
-```
-
-# How to create and deploy an app
-
-```bash
-# Create a project
-zrb project create --project-dir my-project --project-name "My Project"
-cd my-project
-
-# Add a simple python app
-zrb project add simple-python-app --project-dir . --app-name simple --http-port 3000
-
-# Start every app in your project
-zrb project start
-
-# or start a specific app (press ctrl+c first):
-zrb project start-simple
-
-# Open new terminal
-# test if everything works:
-curl http://localhost:3000
-# Press ctrl + c in your first terminal
-
-# Go back to your first terminal
-# Start every app in your project as container (docker-compose required)
-zrb project start-containers
-
-# or start a specific app (press ctrl+c first):
-zrb project start-simple-container
-# Press ctrl + c in your first terminal
-
-# Deploy to kubernetes
-zrb project deploy
-
-#  or deploy specific app
-zrb project deploy-simple
-
-# Remove the deployment
-zrb project destroy
-```
-
-Simple-python-app is a simple Uvicorn application.
-
-For the next iterations, Zrb will also introduce a serious framework for serious software development.
-Stay tunes.
-
-# Autoloaded tasks
-
-Zrb will automatically load the following task definitions:
-
-- Every task definition in `ZRB_INIT_SCRIPTS`.
-    - You can use a colon separator (`:`) to define multiple scripts in `ZRB_INIT_SCRIPTS`. For example:
-        ```bash
-        ZRB_INIT_SCRIPTS=~/personal/zrb_init.py:~/work/zrb_init.py
-        ```
-- Every task definition in `zrb_init.py` in your current directory.
-    - If Zrb cannot find any in your current directory, it will look at the parent directories until it finds one.
-- Every built-in task definition given `ZRB_SHOULD_LOAD_BUILTIN` equals `1` or unset.
-
-# How to define tasks
-
-You can write your task definitions in Python. For example:
-
-```python
-from zrb import (
-    runner, Env,
-    StrInput, ChoiceInput, IntInput, BoolInput, FloatInput, PasswordInput,
-    Group, Task, CmdTask, HTTPChecker, python_task
-)
-
-# Simple Python task.
-# Usage example: zrb concat --separator=' '
-concat = Task(
-    name='concat',  # Task name
-    inputs=[StrInput(name='separator', description='Separator', default=' ')],
-    run=lambda *args, **kwargs: kwargs.get('separator', ' ').join(args)
-)
-runner.register(concat)
-
-# Simple Python task with multiple inputs.
-register_trainer = Task(
-    name='register-trainer',
-    inputs=[
-        StrInput(name='name', default=''),
-        PasswordInput(name='password', default=''),
-        IntInput(name='age', default=0),
-        BoolInput(name='employed', default=False),
-        FloatInput(name='salary', default=0.0),
-        ChoiceInput(
-            name='starter-pokemon',
-            choices=['bulbasaur', 'charmender', 'squirtle']
-        )
-    ],
-    run=lambda *args, **kwargs: kwargs
-)
-runner.register(register_trainer)
-
-
-# Simple Python task with decorator
-@python_task(
-    name='fibo',
-    inputs=[IntInput(name='n', default=5)],
-    runner=runner
-)
-async def fibo(*args, **kwargs):
-    n = int(args[0]) if len(args) > 0 else kwargs.get('n')
-    if n <= 0:
-        return None
-    elif n == 1:
-        return 0
-    elif n == 2:
-        return 1
-    else:
-        a, b = 0, 1
-        for i in range(n - 1):
-            a, b = b, a + b
-        return a
-
-
-# Simple CLI task.
-# Usage example: zrb hello --name='world'
-hello = CmdTask(
-    name='hello',
-    inputs=[StrInput(name='name', description='Name', default='world')],
-    cmd='echo Hello {{input.name}}'
-)
-runner.register(hello)
-
-# Command group: zrb make
-make = Group(name='make', description='Make things')
-
-# CLI task, part of `zrb make` group, depends on `hello`
-# Usage example: zrb make coffee
-make_coffee = CmdTask(
-    name='coffee',
-    group=make,
-    upstreams=[hello],
-    cmd='echo Coffee for you ☕'
-)
-runner.register(make_coffee)
-
-# CLI task, part of `zrb make` group, depends on `hello`
-# Usage example: zrb make beer
-make_beer = CmdTask(
-    name='beer',
-    group=make,
-    upstreams=[hello],
-    cmd='echo Cheers 🍺'
-)
-runner.register(make_beer)
-
-# Command group: zrb make gitignore
-make_gitignore = Group(
-    name='gitignore', description='Make gitignore', parent=make
-)
-
-# CLI task, part of `zrb make gitignore` group,
-# making .gitignore for Python project
-# Usage example: zrb make gitignore python
-make_gitignore_python = CmdTask(
-    name='python',
-    group=make_gitignore,
-    cmd=[
-        'echo "node_modules/" >> .gitignore'
-        'echo ".npm" >> .gitignore'
-        'echo "npm-debug.log" >> .gitignore'
-    ]
-)
-runner.register(make_gitignore_python)
-
-# CLI task, part of `zrb make gitignore` group,
-# making .gitignore for Node.js project
-# Usage example: zrb make gitignore node
-make_gitignore_nodejs = CmdTask(
-    name='node',
-    group=make_gitignore,
-    cmd=[
-        'echo "__pycache__/" >> .gitignore'
-        'echo "venv" >> .gitignore'
-    ]
-)
-runner.register(make_gitignore_nodejs)
-
-# Long running CLI task
-# Usage example: zrb start-server dir='.'
-start_server = CmdTask(
-    name='start-server',
-    upstreams=[make_coffee, make_beer],
-    inputs=[StrInput(name='dir', description='Directory', default='.')],
-    envs=[Env(name='PORT', os_name='WEB_PORT', default='3000')],
-    cmd='python -m http.server $PORT --directory {{input.dir}}',
-    checkers=[HTTPChecker(port='{{env.PORT}}')]
-)
-runner.register(start_server)
-
-# CLI task, depends on `start-server`, throw error
-# Usage example: zrb test-error
-test_error = CmdTask(
-    name='test-error',
-    upstreams=[start_server],
-    cmd='sleep 3 && exit 1',
-    retry=0
-)
-runner.register(test_error)
-```
-
-Once registered, your task will be accessible from the terminal.
-
-For example, you can run a server by performing:
-
-```bash
-export WEB_PORT=8080
-zrb start-server
-```
-
-The output will be similar to this:
-
-```
-Name [world]: Go Frendi
-Dir [.]:
-🤖 ➜  2023-02-22T08:02:52.611040 ⚙ 14426 ➤ 1 of 3 • 🍋            zrb hello • Hello Go Frendi
-🤖 ➜  2023-02-22T08:02:52.719826 ⚙ 14428 ➤ 1 of 3 • 🍊      zrb make coffee • Coffee for you ☕
-🤖 ➜  2023-02-22T08:02:52.720372 ⚙ 14430 ➤ 1 of 3 • 🍒        zrb make beer • Cheers 🍺
-🤖 ➜  2023-02-22T08:02:52.845930 ⚙ 14432 ➤ 1 of 3 • 🍎     zrb start-server • Serving HTTP on 0.0.0.0 port 3000 (http://0.0.0.0:3000/) ...
-🤖 ➜  2023-02-22T08:02:52.910192 ⚙ 14425 ➤ 1 of 1 • 🍈           http-check • HEAD http://localhost:3000/ 200 (OK)
-Support zrb growth and development!
-☕ Donate at: https://stalchmst.com/donation
-🐙 Submit issues/pull requests at: https://github.com/state-alchemists/zaruba
-🐤 Follow us at: https://twitter.com/zarubastalchmst
-zrb start-server completed in 1.681591272354126 seconds
-🤖 ⚠  2023-02-22T08:02:52.911657 ⚙ 14432 ➤ 1 of 3 • 🍎     zrb start-server • 127.0.0.1 - - [22/Feb/2023 08:02:52] "HEAD / HTTP/1.1" 200 -
-```
-
-# How to run tasks programmatically
-
-To run a task programmatically, you need to create a `main loop`.
-
-For example:
-
-```python
-from zrb import CmdTask
-
-
-cmd_task = CmdTask(
-    name='sample',
-    cmd='echo hello'
-)
-main_loop = cmd_task.create_main_loop(env_prefix='')
-result = main_loop() # This run the task
-print(result.output) # Should be "hello"
-```
-
-
-# Enable shell completion
-
-To enable shell completion, you need to set `_ZRB_COMPLETE` variable.
-
-For `bash`:
-
-```bash
-eval $(_ZRB_COMPLETE=bash_source zrb)
-```
-
-For `zsh`:
-
-```bash
-eval $(_ZRB_COMPLETE=zsh_source zrb)
-```
-
-Once set, you will have a shell completion in your session:
-
-```bash
-zrb <TAB>
-zrb md5 hash -<TAB>
-```
-
-Visit [click shell completion](https://click.palletsprojects.com/en/8.1.x/shell-completion/) for more information.
-
-# Configuration
-
-The following configurations are available:
-
-- `ZRB_HOME_DIR`: Zrb home directory.
-    - Default: Zrb home directory
-- `ZRB_LOGGING_LEVEL`: Logging verbosity.
-    - Default: `WARNING`
-    - Possible values:
-        - `CRITICAL`
-        - `ERROR`
-        - `WARNING`
-        - `WARN` (The same as `WARNING`)
-        - `INFO`
-        - `DEBUG`
-        - `NOTSET`
-- `ZRB_INIT_SCRIPTS`: List of task registration script that should be loaded by default.
-    - Default: Empty
-    - Possible values: List of script paths, separated by colons(`:`).
-    - Example: `~/personal/zrb_init.py:~/work/zrb_init.py`
-- `ZRB_ENV`: Environment prefix that will be used when loading Operating System's environment.
-    - Default: Empty
-    - Possible values: Any combination of alpha-numeric and underscore
-    - Example: `DEV`
-- `ZRB_SHOULD_LOAD_BUILTIN`: Whether load builtin tasks or not
-    - Default: `1`
-    - Possible values:
-        - `1`
-        - `0`
-- `ZRB_SHELL`: Default shell for running cmdTask
-    - Default: `bash`
-    - Possible value:
-        - `/usr/bin/bash`
-        - `/usr/bin/sh` 
-- `ZRB_SHOW_ADVERTISEMENT`: Whether show advertisement or not.
-    - Default: `1`
-    - Possible value:
-        - `1`
-        - `0`
-- `ZRB_SHOW_PROMPT`: Whether show prompt or not.
-    - Default: `1`
-    - Possible value:
-        - `1`
-        - `0`
-
-# Quirks
-
-- No one is sure how to pronounce Zrb. Let's keep it that way.
-- If not set, `PYTHONUNBUFFERED` will be set to `1`.
-- Once `zrb_init.py` is loaded, Zrb will automatically:
-    - Set `ZRB_PROJECT_DIR` to `zrb_init.py`'s parent directory.
-    - If loaded as CLI, Zrb will also:
-        - Adding `ZRB_PROJECT_DIR` to `PYTHONPATH`.
-- Zrb passes several keyword arguments that will be accessible from the task's run method:
-    - `_args`: Shell argument when the task is invoked.
-    - `_task`: Reference to the current task.
-- You can access the built-in command groups by importing `zrb.builtin_group`.
-- How environments are loaded:
-    - `env_files` has the lowest priority, it will be overridden by `env`
-    - `env` will override each other, the last one takes greater priority
-    - If you define a `DockerComposeTask`, it will automatically fill your environment with the ones you use in your docker-compose file. The environment defined that way will have a very low priority. They will be overridden by both `env_files` and `env`.
-
-# For contributors
-
-There is a toolkit you can use to test whether Zrb is working as intended.
-
-To use the toolkit, you can invoke the following command:
-
-```bash
-source ./project.sh
-```
-
-Once you load the toolkit, you can start playing around.
-
-```bash
-# Run test and serve coverage.
-zrb test
-
-# Test zrb in playground
-zrb prepare-playground
-```
-
-
-# For maintainers
-
-To publish Zrb, you need a `Pypi` account:
-
-- Log in or register to [https://pypi.org/](https://pypi.org/)
-- Create an API token
-
-You can also create a `TestPypi` account:
-
-- Log in or register to [https://test.pypi.org/](https://test.pypi.org/)
-- Create an API token
-
-Once you have your API token, you need to create a `~/.pypirc` file:
-
-```
-[distutils]
-index-servers =
-   pypi
-   testpypi
-
-[pypi]
-  repository = https://upload.pypi.org/legacy/
-  username = __token__
-  password = pypi-xxx-xxx
-[testpypi]
-  repository = https://test.pypi.org/legacy/
-  username = __token__
-  password = pypi-xxx-xxx
-```
-
-To publish Zrb, you can do the following:
-
-```bash
-source ./project.sh
-
-# Publish Zrb to TestPypi
-zrb publish-test
-
-# Publish Zrb to Pypi
-zrb publish
-```
-