Package: rkd
Task executor - balance between Makefile and Gradle [seedocumentation], designed with :heart:  by RiotKit for DevOps.Easiest and cleanest way to write management scripts and share them between projects, teams and even organizationsRKD is a stable, open-source, multi-purpose automation tool which balance flexibility with simplicity. The primary language is Python
and YAML syntax.RiotKit-Do can be compared toGradleand toGNU Make, by allowing both Python and Makefile-like YAML syntax.Can be used on PRODUCTION, for development, for testing, to replace some of Bash scripts inside docker containers,
and for many more, where Makefile was used.It is not a build tool for Java, but more a DevOps multi-purpose tool. At this time it will not replace Gradle,
but maybe in the future this can be achieved by building community packages with support for building eg. Java applications.Example use casesDocker based production environmentwith multiple configuration files, proceduresDatabase administrator workspace (importing dumps, creating new user accounts, plugging/unplugging databases)Development environment (executing migrations, importing test database, splitting tests and running parallel)On CI (prepare project to run on eg. Jenkins or Gitlab CI) - RKD is reproducible on local computer which makes inspection easierKubernetes/OKD deployment workspace(create shared YAML parts with JINJA2 between multiple environments and deploy from RKD)Automate things like certificate regeneration on production server, RKD can generate any application configs using JINJA2Installers(RKD has built-in commands for replacing lines in files, modifying .env files)Quick start# 1) via PIPpipinstallrkd# 2) Create project (will create a virtual env and prepare files that could be commited to git)rkd:rkd:create-structurePlease check available releases there:https://pypi.org/project/rkd/#historyGoals:Define tasks as simple as in MakefileWrite tasks code in Python as simple as possibleReuse code as simple as in Gradle (using extensions that provides tasks. Extensions are installable from PIP)Simple configuration in PythonIntegrates with GITSuitable for PRODUCTION (log as much as possible, log each executed task into separated *.log files). We planned also extended logging of most important auditing information such as who executed action, and how the state looked in that timeRulesNo hooks eg. task.executeAfter(otherTask), no complex dependenciesNo in-memory state between tasks. State could be only changed in files/database/kv-store like it is in other build systemsNo dynamic tasks names eg. by turning on Publish component it should
not create tasks eg. :publishIWAToDockerRegistry (where IWA is the project name)Don’t pack too many features into the core, do this in external modules. Keep the RKD core clean!Full static analysis, you can work on makefile.py and on task’s code in PyCharm with full code completion!Do early validation. Runtime validation for long running builds is a pain-in-the-ass for the user.Show clear error messages as much as it is possible. Task not found? Tell the user - do not leave a stack trace. Import error in makefile.py? Tell the user + add stack trace. RESPECT TIME OF ALL OF US! :)Do not overuse libraries in RKD core - it must be installable in any environment, including Docker. Libraries count should be small, and the libraries cannot depend on GCC/G++RKD in actionYAML syntax examplePython syntax example (makefile.py)DocumentationPlease read thedocumentationhere.RoadmapCheck our githubmilestones, to see what’s actually planned for next releases.Projects using RKDTaiga - automatic packaging into PRODUCTION docker imageTaiga Events - automatic packaging into PRODUCTION docker imageRiotKit Harbor (upcoming 2.0 version uses RKD) - Automated docker-compose PRODUCTION environment with Service Discovery, automatic SSL, rolling deployments and more!Harbor Simple Router - NGINX image with predefined templates, controlled by environment variablesKubernetes/OKD workspace - create deployments with reusable YAMLsAlternative ways of installationArch Linux AUR packagemade by ragouelReleasingCreate a release in Github releasesWait for pipeline to build and publish to PyPIFrom authorsWe are grassroot activists for social change, so we created RKD especially in mind for those fantastic initiatives:RiotKit (https://riotkit.org)International Workers Association (https://iwa-ait.org)Anarchistyczne FAQ (http://anarchizm.info) a translation of Anarchist FAQ (https://theanarchistlibrary.org/library/the-anarchist-faq-editorial-collective-an-anarchist-faq)Federacja Anarchistyczna (http://federacja-anarchistyczna.pl)Związek Syndykalistów Polski (https://zsp.net.pl) (Polish section of IWA-AIT)Komitet Obrony Praw Lokatorów (https://lokatorzy.info.pl)Solidarity Federation (https://solfed.org.uk)Priama Akcia (https://priamaakcia.sk)Special thanks toWorking Class Historyfor very powerful samples that we could use in our unit tests.