Merge pull request #1 from xmidt-org/code

Initial Creation

.codeclimate.yml

@@ -0,0 +1,31 @@
+version: "2"         # required to adjust maintainability checks
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    enabled: false
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 70
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 10
+  similar-code:
+    config:
+      threshold: 200
+  identical-code:
+    config:
+      threshold: 200

.gitignore

@@ -8,5 +8,7 @@
 # Test binary, build with `go test -c`
 *.test
 
+/vendor
+
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out

.travis.yml

@@ -0,0 +1,28 @@
+language: go
+
+go:
+  - 1.12.x
+
+os:
+  - linux
+  - osx
+
+
+matrix:
+  allow_failures:
+    - go: tip
+  fast_finish: true
+
+install:
+  - GO111MODULE=on go mod vendor
+
+branches:
+    only:
+    - master
+
+script:
+  - if [ -n "$(gofmt -s -l . | grep -v "vendor")" ]; then diff -u <(echo -n) <(gofmt -d $(gofmt -s -l . | grep -v "vendor")); fi
+  - go test -v -race -coverprofile=coverage.txt  $(go list ./... | grep -v "/vendor/")
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v0.1.0]
+- Initial creation, moved from: https://github.com/xmidt-org/codex-deploy
+
+[Unreleased]: https://github.com/xmidt-org/codex-db/compare/v0.1.0..HEAD
+[v0.1.0]: https://github.com/xmidt-org/codex-db/compare/0.0.0...v0.1.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at Comcast_Open_Source_Services@comcast.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+Contribution Guidelines
+=======================
+
+We love to see contributions to the project and have tried to make it easy to 
+do so. If you would like to contribute code to this project you can do so 
+through GitHub by [forking the repository and sending a pull request](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+
+Before Comcast merges your code into the project you must sign the 
+[Comcast Contributor License Agreement (CLA)](https://gist.github.com/ComcastOSS/a7b8933dd8e368535378cda25c92d19a).
+
+If you haven't previously signed a Comcast CLA, you'll automatically be asked 
+to when you open a pull request. Alternatively, we can e-mail you a PDF that 
+you can sign and scan back to us. Please send us an e-mail or create a new 
+GitHub issue to request a PDF version of the CLA.
+
+If you have a trivial fix or improvement, please create a pull request and 
+request a review from a [maintainer](MAINTAINERS.md) of this repository.
+
+If you plan to do something more involved, that involves a new feature or 
+changing functionality, please first create an [issue](#issues) so a discussion of 
+your idea can happen, avoiding unnecessary work and clarifying implementation.
+
+A relevant coding style guideline is the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments).
+
+Documentation
+-------------
+
+If you contribute anything that changes the behavior of the application, 
+document it in the follow places as applicable:
+* the code itself, through clear comments and unit tests
+* [README](README.md)
+
+This includes new features, additional variants of behavior, and breaking 
+changes.
+
+Testing
+-------
+
+Tests are written using golang's standard testing tools, and are run prior to 
+the PR being accepted.
+
+Issues
+------
+
+For creating an issue:
+* **Bugs:** please be as thorough as possible, with steps to recreate the issue 
+  and any other relevant information.
+* **Feature Requests:** please include functionality and use cases.  If this is 
+  an extension of a current feature, please include whether or not this would 
+  be a breaking change or how to extend the feature with backwards 
+  compatibility.
+* **Security Vulnerability:** please report it at 
+  https://my.xfinity.com/vulnerabilityreport and contact the [maintainers](MAINTAINERS.md).
+
+If you wish to work on an issue, please assign it to yourself.  If you have any
+questions regarding implementation, feel free to ask clarifying questions on 
+the issue itself.
+
+Pull Requests
+-------------
+
+* should be narrowly focused with no more than 3 or 4 logical commits
+* when possible, address no more than one issue
+* should be reviewable in the GitHub code review tool
+* should be linked to any issues it relates to (i.e. issue number after (#) in commit messages or pull request message)
+* should conform to idiomatic golang code formatting

MAINTAINERS.md

@@ -0,0 +1,4 @@
+Maintainers of this repository:
+
+* Kristina Spring @kristinaspring
+* Jack Murdock @kcajmagic

NOTICE

@@ -0,0 +1,16 @@
+codex-db
+Copyright 2019 Comcast Cable Communications Management, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This product includes software developed at Comcast (http://www.comcast.com/).

README.md

@@ -1,2 +1,22 @@
 # codex-db
-The database helper functions.
+
+Codex-db provides the database packages needed for the codex project.
+
+[![Build Status](https://travis-ci.com/xmidt-org/codex-db.svg?branch=master)](https://travis-ci.com/xmidt-org/codex-db)
+[![codecov.io](http://codecov.io/github/xmidt-org/codex-db/coverage.svg?branch=master)](http://codecov.io/github/xmidt-org/codex-db?branch=master)
+[![Code Climate](https://codeclimate.com/github/xmidt-org/codex-db/badges/gpa.svg)](https://codeclimate.com/github/xmidt-org/codex-db)
+[![Issue Count](https://codeclimate.com/github/xmidt-org/codex-db/badges/issue_count.svg)](https://codeclimate.com/github/xmidt-org/codex-db)
+[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/codex-db)](https://goreportcard.com/report/github.com/xmidt-org/codex-db)
+[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/codex-db/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/xmidt-org/codex-db.svg)](CHANGELOG.md)
+[![GoDoc](https://godoc.org/github.com/xmidt-org/codex-db?status.svg)](https://godoc.org/github.com/xmidt-org/codex-db)
+
+## Summary
+
+Codex-db provides the database packages needed for the [codex project](https://github.com/xmidt-org/codex-deploy).
+
+## Install
+This repo is a library of packages.  There is no installation.
+
+## Contributing
+Refer to [CONTRIBUTING.md](CONTRIBUTING.md).