temple scaffolding

Author: Joey Leingang

.bumpversion.cfg

@@ -0,0 +1,89 @@
+version: 2
+aliases:
+  - &docker_image circleci/python:3.6-stretch
+  - &dependencies
+    name: Make virtualenv and install dependencies
+    command: |
+      python3 -m venv ~/venv
+      echo ". ~/venv/bin/activate" >> $BASH_ENV
+      source $BASH_ENV
+      make dependencies
+  - &test_boilerplate
+    environment:
+      TEST_REPORTS: /tmp/test-reports
+    steps:
+      - checkout
+      - run:
+          <<: *dependencies
+      - run: make test
+      - store_test_results:
+           path: /tmp/test-reports
+      - store_artifacts:
+           path: /tmp/test-reports
+jobs:
+  temple_check:
+    docker:
+      - image: *docker_image
+    steps:
+      - checkout
+      - run:
+          <<: *dependencies
+      - run: temple update --check
+  lint:
+    docker:
+      - image: *docker_image
+    steps:
+      - checkout
+      - run:
+          <<: *dependencies
+      - run: make validate
+  test_py34:
+    docker:
+      - image: circleci/python:3.4-stretch
+    <<: *test_boilerplate
+  test_py35:
+    docker:
+      - image: circleci/python:3.5-stretch
+    <<: *test_boilerplate
+  test_py36:
+    docker:
+      - image: circleci/python:3.6-stretch
+    <<: *test_boilerplate
+  test_py37:
+    docker:
+      - image: circleci/python:3.7-stretch
+    <<: *test_boilerplate
+  deploy:
+    docker:
+      - image: *docker_image
+    steps:
+      - checkout
+      - add_ssh_keys:
+          fingerprints:
+            - "af:a6:bf:48:f0:08:d6:0f:19:4f:fd:10:f2:9d:50:2c"
+      - run:
+          <<: *dependencies
+      - run: pip install -q -r deploy_requirements.txt
+      - run: python3 deploy.py prod
+
+workflows:
+  version: 2
+  checks_and_deploy:
+    jobs:
+      - temple_check
+      - lint
+      - test_py35
+      - test_py36
+      - test_py37
+      - deploy:
+          requires:
+            - temple_check
+            - lint
+            - test_py34
+            - test_py35
+            - test_py36
+            - test_py37
+          filters:
+            branches:
+              only:
+                - master

.cicleci/config.yml

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yaml,yml}]
+indent_size = 2
+
+[makefile]
+indent_style = tab

.coveragerc

@@ -0,0 +1,41 @@
+# Pylint rules for temporal_sqlalchemy
+
+[MESSAGES CONTROL]
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+disable=bad-continuation,
+    fixme,
+    locally-disabled,
+    locally-enabled,
+    no-else-return,
+    no-init,
+    too-few-public-methods,
+    too-many-arguments,
+    wrong-import-order,
+
+
+[REPORTS]
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=colorized
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+
+[BASIC]
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=__.*__|_.*|test_.*
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=3

.editorconfig

@@ -0,0 +1,61 @@
+Contributing Guide
+==================
+
+This project was created using temple.
+For more information about temple, go to the `Temple docs <https://github.com/CloverHealth/temple>`_.
+
+Setup
+~~~~~
+
+Set up your development environment with::
+
+    git clone [email protected]:CloverHealth/temporal-sqlalchemy.git
+    cd temporal-sqlalchemy
+    make setup
+
+``make setup`` will setup a virtual environment managed by `pyenv <https://github.com/yyuu/pyenv>`_ and install dependencies.
+
+Note that if you'd like to use something else to manage dependencies other than pyenv, call ``make dependencies`` instead of
+``make setup``.
+
+Testing and Validation
+~~~~~~~~~~~~~~~~~~~~~~
+
+Run the tests with::
+
+    make test
+
+Validate the code with::
+
+    make validate
+
+Documentation
+~~~~~~~~~~~~~
+
+`Sphinx <http://www.sphinx-doc.org/>`_ documentation can be built with::
+
+    make docs
+
+The static HTML files are stored in the ``docs/_build/html`` directory. A shortcut for opening them is::
+
+    make open_docs
+
+Releases and Versioning
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Anything that is merged into the master branch will be automatically deployed to PyPI.
+Documentation will be published to `ReadTheDocs <http://temporal-sqlalchemy.readthedocs.io/>`__.
+
+The following files will be generated and should *not* be edited by a user:
+
+* ``ChangeLog`` - Contains the commit messages of the releases. Please have readable commit messages in the
+  master branch and squash and merge commits when necessary.
+* ``AUTHORS`` - Contains the contributing authors.
+* ``version.py`` - Automatically updated to include the version string.
+
+This project uses `Semantic Versioning <http://semver.org>`_ through `PBR <https://docs.openstack.org/developer/pbr/>`_. This means when you make a commit, you can add a message like::
+
+    sem-ver: feature, Added this functionality that does blah.
+
+Depending on the sem-ver tag, the version will be bumped in the right way when releasing the package. For more information,
+about PBR, go the the `PBR docs <https://docs.openstack.org/developer/pbr/>`_.

.pylintrc

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Clover Health Labs, LLC
+Copyright (c) 2016, 2017, 2018, Clover Health Labs, LLC
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without