rcc

module
v0.0.0-...-db661af Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 25, 2024 License: Apache-2.0

README

RCC

RCC allows you to create, manage, and distribute Python-based self-contained automation packages. RCC also allows you to run your automations in isolated Python environments so they can still access the rest of your machine.

🚀 "Repeatable, movable and isolated Python environments for your automation."

Together with robot.yaml configuration file, rcc is a foundation that allows anyone to build and share automation easily.

RCC is actively maintained by Sema4.ai.

Why use rcc?

  • You do not need to install Python on the target machine
  • You can control exactly which version of Python your automation will run on (..and which pip version is used to resolve dependencies)
  • You can avoid Works on my machine
  • No need for venv, pyenv, ... tooling and knowledge sharing inside your team.
  • Define dependencies in conda.yaml and automation config in robot.yaml and let RCC do the heavy lifting.
  • If you have run into "dependency drifts", where once working runtime environment dependencies get updated and break your production system?, RCC can freeze ALL dependencies, pre-build environments, and more.
  • RCC will give you a heads-up if your automations have been leaving behind processes after running.

...and much much more.

👉 If the command line seems scary, just pick up Robocorp Code -extension for VS Code, and you'll get the power of RCC directly in VS Code without worrying about the commands.

Getting Started

⏬ Install rcc

Installation guide

:octocat: Pull robot from GitHub:

rcc pull github.com/robocorp/template-python-browser

🏃 Run robot

rcc run

🐣 Create your own robot from templates

rcc create

For detailed instructions, visit Robocorp RCC documentation to get started. To build rcc from this repository, see the Setup Guide

Installing RCC from the command line

Links to changelog and different versions available here

Windows

  1. Open the command prompt
  2. Download: curl -o rcc.exe https://downloads.robocorp.com/rcc/releases/latest/windows64/rcc.exe
  3. Add to system path: Open Start -> Edit the system environment variables
  4. Test: rcc

macOS

Brew cask from Robocorp tap
  1. Update brew: brew update
  2. Install: brew install robocorp/tools/rcc
  3. Test: rcc

Upgrading: brew upgrade rcc

Linux

  1. Open the terminal
  2. Download: curl -o rcc https://downloads.robocorp.com/rcc/releases/latest/linux64/rcc
  3. Make the downloaded file executable: chmod a+x rcc
  4. Add to path: sudo mv rcc /usr/local/bin/
  5. Test: rcc

Documentation

Visit https://robocorp.com/docs to view the full documentation on the full Robocorp stack.

The changelog can be seen here. It is also visible inside RCC using the command rcc docs changelog.

EULA for pre-built distribution.

Some tips, tricks, and recipes can be found here. These are also visible inside RCC using the command: rcc docs recipes.

Community and Support

The Robocorp community can be found on Developer Slack, where you can ask questions, voice ideas, and share your projects.

License

Apache 2.0

Directories

Path Synopsis
This package holds generated payload from assets directory.
This package holds generated payload from assets directory.
This package holds http client wrapper for cloud access.
This package holds http client wrapper for cloud access.
cmd
This package holds all commands available in rcc.
This package holds all commands available in rcc.
rcc
This package hold commonly shared parts of code.
This package hold commonly shared parts of code.
This package hold simple unit testing helper used in rcc tests.
This package hold simple unit testing helper used in rcc tests.
This package holds mocks/stubs needed in rcc unit tests.
This package holds mocks/stubs needed in rcc unit tests.
This package holds majority of actual functionality of rcc, in form of "operations" that can be done.
This package holds majority of actual functionality of rcc, in form of "operations" that can be done.
This package hold common/shared file/path operations used in rcc.
This package hold common/shared file/path operations used in rcc.
This package hold robot configuration related things.
This package hold robot configuration related things.
This package contains shell execution support used in rcc.
This package contains shell execution support used in rcc.
This package functions as wrapper to viper (library) functionality used in rcc.
This package functions as wrapper to viper (library) functionality used in rcc.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL