add setup.py and version.sh

prepare for packaging

Author: ansemjo

.gitignore

@@ -0,0 +1,8 @@
+# setuptools artifacts
+build/
+dist/
+**/**.egg-info/
+**/__metadata__.py
+
+# cache
+**/__pycache__/

randomart.py

@@ -3,6 +3,7 @@
 # Copyright (c) 2018 Anton Semjonov
 # Licensed under the MIT License
 
+from randomart import __metadata__ as metadata
 from numpy import zeros, array
 import hashlib
 
@@ -91,7 +92,10 @@ def int3(arg):
       raise argparse.ArgumentTypeError("argument not divisible by 3")
     return i
 
-  parser = argparse.ArgumentParser()
+  parser = argparse.ArgumentParser(
+    description=metadata.DESCRIPTION,
+    epilog="%%(prog)s version %s" % metadata.VERSION,
+  )
   parser.add_argument(
       "file",
       type=argparse.FileType("rb"),

randomart/__init__.py

@@ -0,0 +1,4 @@
+try:
+  from .__metadata__ import VERSION as __version__
+except ImportError:
+  __version__ = "development"

setup.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2019 Anton Semjonov
+# Licensed under the MIT License
+
+# metadata
+NAME = "randomart"
+AUTHOR = "Anton Semjonov"
+EMAIL = "anton@semjonov.de"
+URL = "https://github.com/ansemjo/randomart"
+LICENSE = "MIT"
+DESCRIPTION = "Generate ASCII randomart by hashing input and using an adapted drunken bishop alogirthm."
+KEYWORDS = "randomart drunken bishop openssh hash comparison"
+SCRIPTS = [NAME + ".py"]
+PYTHON = ">3.5"
+REQUIREMENTS = ["numpy"]
+
+# imports
+from os import environ
+from pathlib import Path as path
+from subprocess import check_output as cmd
+from setuptools import setup, find_packages
+
+# read current version
+environ["REVISION_SEPERATOR"] = "-dev"
+VERSION = cmd(["sh", "version.sh", "version"]).strip().decode()
+
+# embed package metadata subset
+with (path(NAME) / "__metadata__.py").open("w") as v:
+    v.write(f'VERSION = "{VERSION}"\n')
+    v.write(f'AUTHOR = "{AUTHOR}"\n')
+    v.write(f'URL = "{URL}"\n')
+    v.write(f'DESCRIPTION = "{DESCRIPTION}"\n')
+
+setup(
+    name=NAME,
+    description=DESCRIPTION,
+    keywords=KEYWORDS,
+    version=VERSION,
+    license=LICENSE,
+    author=AUTHOR,
+    author_email=EMAIL,
+    url=URL,
+    scripts=SCRIPTS,
+    packages=find_packages(),
+    python_requires=PYTHON,
+    install_requires=REQUIREMENTS,
+)

version.sh

@@ -0,0 +1,90 @@
+#!/bin/sh
+
+# Copyright (c) 2018 Anton Semjonov
+# Licensed under the MIT License
+
+# This script prints version information for a project managed with Git when
+# executed in a shell. It works from checked-out repositories or downloaded
+# archives alike. For more information see https://github.com/ansemjo/version.sh
+
+# -- SYNOPSIS -- Copy this script to your project root and add the line
+# 'version.sh export-subst' to your .gitattributes file, creating it if it does
+# not exist. Commit both files, try running 'sh ./version.sh' and use annotated
+# Git tags to track your versions.
+
+# Ignore certain shellcheck warnings:
+# - '$Format..' looks like a variable in single-quotes but this is
+#     necessary so it does _not_ expand when interpreted by the shell
+# - backslash before a literal newline is a portable way
+#     to insert newlines with sed
+# shellcheck disable=SC2016,SC1004
+
+# Magic! These strings will be substituted by 'git archive':
+COMMIT='$Format:%H$'
+REFS='$Format:%D$'
+
+# Fallback values:
+FALLBACK_VERSION='commit'
+FALLBACK_COMMIT='unknown'
+
+# Revision and commit hash seperators in 'describe' string:
+REVISION_SEPERATOR="${REVISION_SEPERATOR:--}"
+COMMIT_SEPERATOR="${COMMIT_SEPERATOR:--g}"
+
+# Check if variables contain substituted values?
+subst() { test -n "${COMMIT##\$Format*}" && test -n "${REFS##\$Format*}"; }
+
+# Check if git and repository information is available?
+hasgit() {
+  command -v git >/dev/null && { test -r .git || git rev-parse 2>/dev/null; };
+}
+
+# Parse the %D reflist in $REFS to get a tag or branch name:
+refparse() {
+  # try to find a tag:
+  tag=$(echo "$REFS" | sed -ne 's/.*tag: \([^,]*\).*/\1/p');
+    test -n "$tag" && echo "$tag" && return 0;
+  # try to find a branch name:
+  branch=$(echo "$REFS" | sed -e 's/HEAD -> //' -e 's/, /\
+/' | sed -ne '/^[a-z0-9._-]*$/p' | sed -n '1p');
+    test -n "$branch" && echo "$branch" && return 0;
+  # nothing found, no tags and not a branch tip?
+  return 1;
+}
+
+# Try to get commit and version information with git:
+gitcommit() {
+  hasgit && git describe --always --abbrev=0 --match '^$' --dirty;
+}
+gitversion() {
+  hasgit && {
+    {
+      # try to use 'describe':
+      V=$(git describe 2>/dev/null) && \
+      echo "$V" | sed 's/-\([0-9]*\)-g.*/'"$REVISION_SEPERATOR"'\1/';
+    } || {
+      # or count the number of commits otherwise:
+      C=$(git rev-list --count HEAD) && \
+      printf '0.0.0%s%s' "$REVISION_SEPERATOR" "$C";
+    };
+  };
+}
+
+# Wrappers to return version and commit (substituted -> git info -> fallback):
+version() { subst && refparse || gitversion || echo "$FALLBACK_VERSION"; }
+commit()  { subst && echo "$COMMIT" || gitcommit || echo "$FALLBACK_COMMIT"; }
+describe() { printf '%s%s%.7s\n' "$(version)" "$COMMIT_SEPERATOR" "$(commit)"; }
+
+# Parse commandline argument:
+case "$1" in
+  version)  version ;;
+  commit)   commit ;;
+  describe) describe ;;
+  json)
+    printf '{"version":"%s","commit":"%s","describe":"%s"}\n' \
+      "$(version)" "$(commit)" "$(describe)" ;;
+  help)
+    printf '%s [version|commit|describe|json]\n' "$0" ;;
+  *)
+    printf 'version : %s\ncommit  : %s\n' "$(version)" "$(commit)" ;;
+esac