aws-mp-utils 0.0.1__tar.gz

aws_mp_utils-0.0.1/CHANGES.md

@@ -0,0 +1,4 @@
+v0.0.1 (2025-08-14)
+===================
+
+- Initial release

aws_mp_utils-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+Installation
+============
+
+```shell
+$ git clone https://github.com/SUSE-Enceladus/aws-mp-utils.git
+$ cd aws-mp-utils
+
+# Activate virtual Environment then install
+# aws-mp-utils and dev dependences in editable mode
+$ pip install -e .[dev]
+```
+
+aws-mp-utils is now installed in the active virtual environment in
+development mode.
+
+Dev Requirements
+================
+
+- bumpversion
+
+Testing Requirements
+====================
+
+- coverage
+- flake8
+- pytest
+- pytest-cov
+
+Contribution Checklist
+======================
+
+- All patches must be signed. [Signing Commits](#signing-commits)
+- All contributed code must conform to flake8. [Code Style](#code-style)
+- All new code contributions must be accompanied by a test.
+    - Tests must pass and coverage remain above 90%. [Unit & Integration Tests](#unit-&-integration-tests)
+- Follow Semantic Versioning. [Versions & Releases](#versions-&-releases)
+
+Versions & Releases
+===================
+
+**aws-mp-utils** adheres to Semantic versioning; see <http://semver.org/> for
+details.
+
+[bumpversion](https://pypi.python.org/pypi/bumpversion/) is used for
+release version management, and is configured in `setup.cfg`:
+
+```shell
+$ bumpversion major|minor|patch
+$ git push
+```
+
+Bumpversion will create a commit with version updated in all locations.
+The annotated tag is created separately.
+
+```shell
+$ git tag -a v{version}
+# git tag -a v0.0.1
+
+# Create a message with the changes since last release and push tags.
+$ git push --tags
+```
+
+Unit & Integration Tests
+========================
+
+All tests should pass and test coverage should remain above 90%.
+
+The tests and coverage can be run directly via pytest.
+
+```shell
+$ pytest --cov=aws_mp_utils
+```
+
+Code Style
+==========
+
+Source should pass flake8 and pep8 standards.
+
+```shell
+$ flake8 aws-mp-utils
+```
+
+Signing Commits
+===============
+
+The repository and the code base patches sent for inclusion must be GPG
+signed. See the GitHub article, [Signing commits using
+GPG](https://help.github.com/articles/signing-commits-using-gpg/), for
+more information.