Merge branch 'develop' into new-ami-and-explicit-block-device-mappings

Makefile

@@ -1,3 +1,7 @@
+PKG := azanium
+PYTHON ?= $(shell which python3)
+PIP := ${PYTHON} -m pip
+DIST_NAME ?= $(shell ${PYTHON} setup.py --fullname)
 
 define print-help
 	$(if $(need-help),$(warning $1 -- $2))
@@ -7,11 +11,18 @@ need-help := $(filter help,$(MAKECMDGOALS))
 
 help: ; @echo $(if $(need-help),,Type \'$(MAKE)$(dash-f) help\' to get help)
 
-install: $(call print-help,install,installs the Python package)
-	@python3 setup.py dist
+dev: $(call print-help,dev,installs the ${PKG} python package for development)
+	@if ! test -d "${VIRTUAL_ENV}"; then \
+		echo "ERROR: No virtualenv active"; \
+		exit 1; fi
+	${VIRTUAL_ENV}/bin/python3 -m pip install -e ".[dev]"
+
+install: $(call print-help,install,installs the ${PKG} python package in user-space)
+	${PYTHON} setup.py sdist 2> /dev/null
+	${PIP} install --user "dist/${DIST_NAME}.tar.gz"
 
 uninstall: $(call print-help,uninstall,un-installs the Python package)
-	@python3 -m pip uninstall -y wormbase-db-build
+	${PIP} uninstall -y "${PKG}"
 
 clean: $(call print-help,clean,Cleans build artefacts)
 	@rm -rf build dist
@@ -29,4 +40,4 @@ admin-docs: $(call print-help,admin-docs,Builds the documentation for admins)
 docs-all: $(call print-help,docs-all,Builds all documentation) dev-docs admin-docs user-docs
 
 
-.PHONY: install uninstall clean admin-docs dev-docs docs-all user-docs
+.PHONY: dev install uninstall clean admin-docs dev-docs docs-all user-docs

docs/admin/iam-setup.rst

@@ -24,7 +24,7 @@ The rationale
 
 IAM admin tool (`azanium admin`)
 ================================
-For convenience, the `wormbase-db-migration` package provides a
+For convenience, the `azanium` package provides a
 :term:`CLI` for performing the *minimal* :term:`IAM` configuration
 necessary for a migration to be performed.
 
@@ -37,13 +37,15 @@ necessary for a migration to be performed.
 
 .. ATTENTION::
    The remainder of this document provides a walk-through of how one
-   would work with :term:`AWS` :term:`IAM` scheme employed by
-   :term:`azanium admin`.
+   would manually setup the  :term:`AWS` :term:`IAM` scheme.
+   The  :term:`azanium admin` automates this.
 
-   The commands below should not need to be used in normal
-   circumstances.  This is because using Amazon's AssumeRole API
-   requires specification of an :term:`ARN` when forming relationships
-   between trusted entities in :term:`IAM`.
+   The commands shown below illustrate the steps required to configure
+   IAM such that users can use the `AssumeRole` API.
+
+   The `azanium admin` command was written, as the formation of these
+   policies require specification of a fully-qualified :term:`ARN`
+   when forming relationships between trusted entities in :term:`IAM`.
 
 Initial configuration
 =====================

docs/user/db-migration-procedure.rst

@@ -19,10 +19,10 @@ The following steps should be executed in order.
 
       AWS_PROFILE="${USER}"
       WB_DATA_RELEASE="WS254"
-      WB_DB_RELEASE_TAG="0.1"
+      TAG="0.1"
       azanium cloud --profile $USER \
 		    init \
-      		    "dist/wormbase-db-migration-${WB_DB_RELEASE}.tar.gz" \
+      		    "dist/azanium-${TAG}.tar.gz" \
 		    "${WB_DATA_RELEASE}"
 
 .. _db-migration-step-2: