Initial Package Scaffolding (#1)

* Ignore all .env*

* Add Dockerfile

* Add CI script

* Add test, lint, and publish scripts

* Add setup.py

* Basic CONTRIBUTOR.md

* Add compose files

* Add hello world test

* Add packages

* Add package structure

* Add no-op function for CI testing

Author: meierj-wayscript

.circleci/config.yml

@@ -5,7 +5,12 @@ jobs:
       - image: circleci/python:3.8.11
     working_directory: ~/wayscript-python
     steps:
+      - setup_remote_docker:
+          version: 20.10.6
       - checkout
+      - run:
+          name: lint
+          command: docker-compose -f docker-compose.ci.yml run --rm app lint
       - run:
           name: test
-          command: docker-compose run --rm app test
+          command: docker-compose -f docker-compose.ci.yml run --rm app test

.gitignore

@@ -103,6 +103,7 @@ celerybeat.pid
 
 # Environments
 .env
+.env*
 .venv
 env/
 venv/

CONTRIBUTOR.md

@@ -0,0 +1,24 @@
+# Contribution Guide
+
+## Running Locally
+
+To speed up development cycles you can run tests and linting locally with:
+```
+docker-compose run --rm app lint
+docker-compose run --rm app test
+```
+This will mount your local working directory into the container and set it as the working directory within the container.
+
+To exactly replicate the CI steps, add the `-f docker-compose.ci.yml` arg to the above commands.
+
+## Publishing A New Version
+
+To cut a new version, follow these steps:
+
+- create and merge final feature branch updating `CHANGELOG.md`
+- tag final commit hash with `git tag <VERSION>`, e.g. `git tag 0.1.3`.
+- publish to pypi with:
+```
+docker-compose run --rm app bash publish.sh
+```
+- push tag to github with `git push --tags`

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.8.11-buster AS base
+LABEL org.wayscript.image.authors="founders@wayscript.com"
+
+ENV SRC_DIR /usr/local/src/project
+WORKDIR ${SRC_DIR}
+
+RUN pip3 install pipenv
+
+COPY Pipfile Pipfile.lock ${SRC_DIR}/
+
+RUN pipenv install --system --dev && \
+    rm -rf /root/.cache/pip
+
+COPY ./files/ /
+
+COPY ./ ${SRC_DIR}/
+
+RUN chmod u+x /usr/local/bin/*

Pipfile

@@ -0,0 +1,16 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+pytest = "*"
+twine = "*"
+pytest-xdist = "*"
+pyflakes = "*"
+tag-version = "*"
+
+[requires]
+python_version = "3.8"

Pipfile.lock

@@ -0,0 +1,12 @@
+version: '3'
+services:
+  app:
+    build:
+      context: .
+    environment:
+      - TWINE_USERNAME=__token__
+      - TWINE_NON_INTERACTIVE=1
+      - TWINE_PASSWORD
+    stdin_open: true
+    tty: true
+