Merge pull request krysopath#26 from krysopath/org-readme

Org readme

.githooks/pre-commit.d/00-black

@@ -1 +1,13 @@
-black ./vaultify
+#!/bin/sh
+
+# Stash unstaged changes
+git stash -q --keep-index
+
+black \
+	--exclude venv\
+	.
+
+# Stage updated files
+git add -u
+# Re-apply original unstaged changes
+git stash pop -q

Makefile

@@ -11,9 +11,12 @@ ci: run/tests\
 dev/ci:
 	ls vaultify/*py Dockerfile .vaultify.yml | entr -s 'make run/tests'
 
-artifact/pkg:
+artifact/pkg: clean
 	python3 setup.py sdist bdist_wheel
 
+pypi: artifact/pkg
+	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
 artifact/docker:
 	docker build \
 	    --build-arg BASE_IMAGE=$(BASE_IMAGE)\
@@ -30,7 +33,7 @@ artifact/tag:
 		vaultify:$(TAG)
 
 clean:
-	rm -rf tests/new* assets/*
+	rm -rf tests/new* assets/* build/ dist *vaultify.egg*
 
 run/tests: clean
 	cp tests/test-config.env assets/secrets.plain
@@ -53,13 +56,13 @@ run/tests: clean
 manual:
 	@groff -man -Tascii man/vaultify.1
 
-dev/install/packaging:
+dev/install/tools:
 	python3\
 		-m pip\
 		install\
 		--user\
 		--upgrade\
-		pip setuptools wheel
+		pip setuptools wheel twine black
 
 dev/install/os:
 	sudo apt-get install gnupg openssl

README.org

@@ -0,0 +1,43 @@
+#+TITLE: vaultify - hexagon of secrets 
+#+OPTIONS:
+#+AUTHOR: Georg vom Endt ([email protected])
+
+* Introduction
+Vaultify is secret provisioning method. It can be used to read/write
+from/to resources and pass environment values to spawned processes. 
+
+Originally a simple bash script fetching from HashiCorp Vault and
+writing as dotenv file, it quickly became an API for providing secrets
+from any arbitrary URI to consume the secrets via another arbitrary URI
+
+* Installation
+This section explains different installation methods.
+** Requirements
+   - python3.6, python3.7
+   - pip
+   - docker (obsoletes the above)
+
+** from pypi
+Most implementers will fetch the package from pypi and build their own
+things on another layer.
+#+BEGIN_SRC shell
+pip3 install vaultify
+#+END_SRC
+
+** from git
+Alternatively fetch the sources from github to develop your own
+adapter classes.
+#+BEGIN_SRC shell
+git clone [email protected]:krysopath/vaultify.git
+#+END_SRC
+** os dependencies
+These tools can greatly speed up local development, when used in
+conjunction via ~make~, so install them. They can overwhelm you with
+output, too.
+
+*** debian
+#+BEGIN_SRC shell
+apt-get install make entr yamllint pylint bandit 
+pip3 install black
+#+END_SRC
+

README.rst

@@ -0,0 +1,57 @@
+=============================
+vaultify - hexagon of secrets
+=============================
+
+    :Author: Georg vom Endt ([email protected])
+
+.. contents::
+
+
+
+1 Installation
+--------------
+
+This section explains different installation methods.
+
+1.1 Requirements
+~~~~~~~~~~~~~~~~
+
+- python3.6, python3.7
+
+- pip
+
+- docker (obsoletes the above)
+
+1.2 from pypi
+~~~~~~~~~~~~~
+
+Most implementers will fetch the package from pypi and build their own
+things on another layer.
+
+.. code:: shell
+
+    pip3 install vaultify
+
+1.3 from git
+~~~~~~~~~~~~
+
+Alternatively fetch the sources from github to develop your own
+adapter classes.
+
+.. code:: shell
+
+    git clone [email protected]:krysopath/vaultify.git
+
+1.4 os dependencies
+~~~~~~~~~~~~~~~~~~~
+
+These tools can greatly speed up local development, when used in
+conjunction via ``make``, so install them. They can overwhelm you with
+output, too.
+
+1.4.1 ubuntu
+^^^^^^^^^^^^
+
+.. code:: shell
+
+    apt install make entr yamllint pylint bandit

assets/.gitignore

@@ -1,2 +1,3 @@
 *.enc
 *.gpg
+*.plain