reveal-scriptlibtool

View Github Repository Open presentation in a new window

krisztianfekete

See all presentation from krisztianfekete

reveal-scriptlibtool

0 0

reveal-scriptlibtool

a reveal.js presentation about `script` vs `lib` vs `tool`

On Github krisztianfekete / reveal-scriptlibtool

Names for

code fragments

(based on reusability)

2013 October, @kr

Code category

Tool

  • directly executable
  • reusability supported by parameters
  • independent of developer's machine
  • easily installable with dependencies

Is it a script, then?

NO!

Usually the "script" you think of have

  • hard coded parameters restricting the code to run only on the developer's machine
  • no machine readable description of used libraries, dependencies

Code category

Script

  • performs a concrete task
  • is directly executable
  • has all its parameters hard coded -> take NO user given parameters
  • is NOT reusable by design

Come on!

I know from experience, that

  • reuse is possible by modifying the script
  • modification of scripts is the most common reuse of all

???

Depending on

code modification is

strongly discouraged !

Why?

  • code modification is inherently a manual work

  • manual work directly translates to time:

    • where to modify?
    • what to modify?
    • test... test...
  • would I be happy to take over the task of running someone else's scripts?

Are scripts bad, then?

NO!

They

  • are extremely useful building blocks
  • are the easiest to create compared to other components

  • can be quite easily "upgraded" to become tools:

    • hard coded parameters can be replaced with real parameters
    • a machine readable description of dependencies can be added

Code category

Library

  • NOT executable
  • pure reusable code
  • invisible for the user
  • solve hard problems or provides convenience
  • eliminates the need for code repetition (in other words: minimalizes boilerplate)
  • should be tested and bug free
  • must be known to be used
  • must have a good documentation, to be usable
  • requires patience and skill to build
  • thus, good libraries are very valuable

How do different kinds

of codes work together?

Every code can use libraries and call tools, but generally

  • a tool makes functionality in a library accessible to end-users

  • a library provides new functionality to other code

How can we reuse code?

Packages

Python packaging

is a mess :(

Packages are stored in a variety of formats:

  • [binary and source] eggs (deprecated)
  • [source] tar balls
  • zips
  • wheels (maybe the future?)

Package repositories

Collect user installable packages.

The main (or public) repository is: https://pypi.python.org/pypi

Our private one is at http://devpi.microdata.ceu.hu

Using python packages

  • virtualenv
  • pip
  • configuration for our own package index (TBD, .pip/pip.conf)

STATA packages

This looks like describing one packaging solution:

http://www.stata.com/support/ssc-installation/

Other STATA solutions are looking cookbook like by description. (correct me if they are not!)

Examples

Script ... TBD

THE END

Created with reveal.js