Giter Club home page Giter Club logo

utils's Introduction

utils

Build Status

utils is a repository of scripts used by the Open Computing Facility at the University of California, Berkeley.

What belongs here

Scripts for humans do

In general, scripts which might be executed by a person should go here. System scripts (things that go primarily in cronjobs or similar) should go in the ocf/puppet repo instead.

Scripts of all languages are welcome, and should be organized into appropriate directories. Use staff/ for anything that will typically only be executed by staff.

Libraries don't

If your utility is meant to be imported, it should probably go in ocflib instead. If you're writing a script whose functionality might be useful elsewhere, separate that out, put it in ocflib, and call it from a binary in this repo.

General best practices

All languages

  • Executable files should be marked executable, contain a proper shebang, and generally not have a file extension.

Python

  • Use ocflib functionality when it exists, and put reusable code there (and call it from an executable here).
  • When possible, target Python 3.5 and 3.7 (same versions as ocflib)
  • Generally follow PEP8.

Shell/Bash

  • Use /bin/bash over /bin/sh unless your script is for some alien environment where there is no bash. Don't be afraid to use bashisms.
  • Typically add set -euo pipefail, especially for any complicated scripts. This (a) stops on errors, (b) errors on accessing undefined variables, and (c) errors on failures in the middle of a pipeline. Together these make Bash into something resembling a passable programming language.
  • Quote things and otherwise follow best practices.

Other languages

  • Consider writing in Python instead.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.