Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaronahmid/robotarm
A simple automation tool written in python to handle tedious and repetitive tasks.
https://github.com/aaronahmid/robotarm
automation bash-script configuration-management flask-api json json-api micro python rest yaml
Last synced: 8 days ago
JSON representation
A simple automation tool written in python to handle tedious and repetitive tasks.
- Host: GitHub
- URL: https://github.com/aaronahmid/robotarm
- Owner: aaronahmid
- License: mit
- Created: 2021-10-31T17:03:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-06T09:54:26.000Z (over 1 year ago)
- Last Synced: 2023-07-06T10:36:26.435Z (over 1 year ago)
- Topics: automation, bash-script, configuration-management, flask-api, json, json-api, micro, python, rest, yaml
- Language: Python
- Homepage:
- Size: 118 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROBOT-ARM
RobotArm is a Python dev configuration management and automation tool that enables quick and easy creation and management of development environments.
## Features
- start and stop the arm service easily
- Easily create a python development environment from a yaml file as states
- run management commands easily from any directory in your terminal
- run tests easily from any directory in your terminal
- manage your virtual environments without breaking a sweat
- provision development databases easily (currently onlu supports PostgreSQL)
## Future Features
- create ci/cd cycles from yaml files
- use multiple environments
- setting up local git repo, and using git commands easily from any directory in your terminal
## How to install
> The current versions only run on Ubuntu-20.04+
- download the latest release
- extract source file
- install with pip
> ``pip install .``
## Basics
- start arm API service
> `` arm service start ``
> confirm APIs are running ``arm service status``
- to stop the API service
> `` arm service stop ``
- create a state
> ``arm [-s, --state] create full/path/file_name.yaml (tips: `pwd`\file_name.yaml)``
- list of available states
> ``arm [-s, --state] list``
- activate state
> ``arm [-s, --state] activate state_id``
- run management commands e.g django
>``arm [-c, --command] management_cmd``
- run tests
>``arm [-t, --tests] run [defaults to test discorvery)``
------------------------------------------------------------------------------------------------------------------------
## Yaml Config File Template
```yaml
name: error-response-handler
version: v0.0.1
git: https://github.com/aaronahmid/error-response-handler
git_ssh: [email protected]/aaronahmid/error-response-handler
wdir: /home/krummitz/projects/error-response-handler
venvs:
- name: venv
dir: .
on_create: true
databases:
- name: error-handler-db
type: postgresql
user: krumitz
password: '[DB_PASSWORD]'
host: '[DB_HOST]'
port: '[DB_PORT]'
on_create: true
tests:
- tool: unittest
discovery: .
test_dir: tests
```
------------------------------------------------------------------------------------------------------------------------
### Arm currently only supports only the Django web framework, when used with a framework
> This tool is not totally safe, it's not completed and there are several bugs, not yet documented properly. Use with care!!
> Contribute?? Uhhhhhhhhm! Nope Not yet...
> To infinity and beyond
> -Buzz Lightyear's