2.0.0 Release

.github/workflows/ci.yaml

@@ -5,18 +5,23 @@ on: [push]
 jobs:
   lint:
     runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+      matrix:
+        version: [3.11, 3.12]
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.11
+    - name: Set up Python ${{ matrix.version}}
       uses: actions/setup-python@v3
       with:
-        python-version: '3.11'
+        python-version: "${{ matrix.version }}"
 
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        python -m pip install -r requirements.txt
 
     - name: Install Pylint
       run: pip install pylint
@@ -28,14 +33,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 5
+      matrix:
+        version: [3.11, 3.12]
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.11
+    - name: Set up Python ${{ matrix.version}}
       uses: actions/setup-python@v3
       with:
-        python-version: '3.11'
+        python-version: "${{ matrix.version }}"
 
     - name: Install dependencies
       run: |  
@@ -49,4 +56,7 @@ jobs:
       run: python -m pip install -e .
 
     - name: Run tests
-      run: pytest
+      run: pytest tests
+
+    - name: Upload coverage to Coveralls
+      uses: coverallsapp/github-action@v2

.gitignore

@@ -42,6 +42,7 @@ htmlcov/
 .nox/
 .coverage
 .coverage.*
+coverage.*
 .cache
 nosetests.xml
 coverage.xml
@@ -160,3 +161,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.vscode

CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2024-06-20
+
+### Added
+- Added `ValidationContext` class to keep track of current validation path and errors up until a certain point.
+- Added `examples` folder
+- Added explanation regarding `ZonString.datetime()` decisions.
+- Added `ZonLiteral`, `ZonTuple` and `ZonEnum` classes
+- Added more `ZonRecord` methods
+- Added coverage
+
+### Changed
+- Moved everything into a single file to combat circular reference issues
+- Deprecated `ValidationError` in favor of `ZonError`.
+- Simplified validation logic
+- Now returns a (deep-) copy of the original data after validation. This is more useful for `ZonRecord` and `ZonString` validators that can transform, while transformers are not added.
+
+### Removed
+- Removed `between`, `__eq__` and `equals` methods from `ZonNumber`.
+- Removed `ZonInteger` and `ZonFloat` in favor of new validation rules in `ZonNumber`
+- Removed `true` and `false` methods from `ZonBoolean`
+
+## [1.1.0] - 2024-04-10
+
+### Added
+- `zon` now has a changelog.
+- Added `zon.traits` module for common functionality that is specific to no validator.
+- Added the `zon.traits.collection` file which contains the `ZonCollection` class: this is the base class for all collection types.
+- Added testing for `ZonCollection` and added more tests for `ZonString`.
+- Scripts that automate the building and publishing of the package to PyPI.
+- Added `refine` method to the base `Zon` class.
+
+### Changed
+- `ZonString` now inherits from `ZonCollection` instead of `Zon`.
+- `ZonList` now inherits from `ZonCollection` instead of `Zon`.
+- Updated `README.md` to include more information and examples of code usage.
+
+### Removed
+- Removed the `len` function from `ZonString` and `ZonList` as it was not being used and did too much.
+
+## [1.0.0] - 2023-11-26
+
+### Added
+- Added base source code files for the project.
+- Base `README.md` file.
+
+[unreleased]: https://github.com/Naapperas/zon/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/Naapperas/zon/compare/v1.1.0...v1.1.0
+[1.0.0]: https://github.com/Naapperas/zon/releases/tag/v1.0.0