Initial commit

Author: EpicWink

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Report a problem
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+A paragraph or two describing the bug.
+
+## Reproduction
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '...'
+4. See error
+
+## Expected behaviour
+A clear and concise description of what you expected to happen.
+
+## Actual behaviour
+Include current behaviour and output.
+
+## Environment
+* `dynamodb-serialise`: version (run: `pip show dynamodb-serialise`)
+* Python: version (run: `python --version`)
+* OS: Windows 10 / Ubuntu 20.04 / OSX

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Request a feature
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+A paragraph or two summarising the feature request.
+
+## Problem definition
+
+## Current behaviour and workarounds
+
+## Proposed solution (optional)

.github/pull_request_template.md

@@ -0,0 +1,3 @@
+A paragraph or two summarising the changes.
+
+Issue: reference

.github/workflows/publish-python-package.yml

@@ -0,0 +1,24 @@
+name: publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+    - name: Build package
+      run: |
+        pip install build
+        pyproject-build
+    - name: Publish package
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        pip install twine
+        twine upload dist/*

.github/workflows/test-python-package.yml

@@ -0,0 +1,35 @@
+name: test
+
+on:
+  pull_request:
+    branches:
+    - master
+  push:
+    branches:
+    - master
+    - ver/*
+    tags:
+    - v*
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install package
+      run: pip install .
+    - name: Run test suite
+      run: |
+        pip install -r tests/requirements.txt
+        pytest -vvra
+    - name: Lint with black
+      run: |
+        pip install black
+        black --check src

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+.venv
+setup.py
+dist/
+__pycache__/
+*.egg-info/

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 both within project spaces and in public spaces
+when an individual is representing the project or its community. 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 laurie_opperman@hotmail.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,34 @@
+# Contribution guide
+Thanks for wanting to help out!
+
+## Development environment set-up
+Create a new `setup.py`:
+```python
+from setuptools import setup
+
+setup()
+```
+
+Install package
+```shell
+pip install -e .
+```
+
+Install package testing requirements
+```shell
+pip install -r tests/requirements.txt black
+```
+
+## Testing
+Run the test suite
+```shell
+pytest -vvra
+```
+
+Run linting
+```shell
+black --check src
+```
+
+## Submitting changes
+Make sure the above test is successful, then make a pull-request on GitHub. 

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2021 Laurie O
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# DynamoDB value serialisation and deserialisation
+Convert values from AWS DynamoDB to native Python types.
+
+Makes more sensible decisions about numbers and binary values, at the cost of
+floating-point precision. Very lightweight.
+
+## Installation
+```shell
+pip install dynamodb-serialise
+```
+
+## Usage
+```python
+import dynamodb_serialise
+
+dynamodb_serialise.deserialise(
+    {"M": {"foo": {"N": "42"}, "bar": {"B": "c3BhbQ=="}}}
+)
+# {'foo': 42, 'bar': b'spam'}
+
+dynamodb_serialise.serialise(
+    {'foo': 42, 'bar': b'spam'}, bytes_to_base64=True
+)
+# {"M": {"foo": {"N": "42"}, "bar": {"B": "c3BhbQ=="}}}
+```