Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

S{cripting,ystem,tack} Management (SM) Framework (Core)

tree: 26467b8763

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Bash Delectable Scripting Modules (BDSM) Framework

The BDSM Framework is a... scripting management framework, with modules (go figure)!

Goal

The goal is to create a framework for maintaining and sharing server side scripts while exposing them through a consistent command line interface (CLI).

Architecture

BDSM itself is a scripting framework. Users may write and/or install 'extensions' (think plugins) to the core framework in order to add CLI functionality to BDSM.

Creating Extensions

There are only a few requirements for the 'extensions'. The extension must be a directory. Within this directory are (at least) the subdirectory bin/ with at least one executable file called 'help'. Additionally in the root of the extension directory there must be a text file called VERSION with a version number that follows semantic versioning (http://semver.org/) in the format of X.Y.Z where X,Y and Z are positive integers. An extension must also have a README file in which you should explain about the extension.

The contents of the bin directory can be any execuatble file. This means for example that C compiled binaries, Ruby Scripts, python, lua, etc... may all be used according to requrements and/or user preferences. Of course the extensions which I write will likely be in bash ;) Additionally if you write your extensions in bash a nice DSL is automatically loaded for you. Read more about the DSL in the online documentation.

~Wayne

Wayne E. Seguin wayneeseguin@gmail.com http://github.com/wayneeseguin http://twitter.com/wayneeseguin

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using the latest development and release versions by reporting bugs in #beginrescueend on irc.freenode.net by suggesting new features in #beginrescueend on irc.freenode.net by writing or editing documentation by translating documentation to a new language by writing extensions by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace) by refactoring code by resolving issues by reviewing patches

License

All BDSM Core scripts and extensions themselves are are licensed under the Apache License v2.0

Copyright (c) 2009-2011 Wayne E. Seguin

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

bin/bdsm-ll is GNU Parallel and is licensed under the GNU GPL v3 which can be read here: http://www.gnu.org/licenses/gpl.html

Something went wrong with that request. Please try again.