feat: pydantic-csv

Author: Nathan Richard

.github/FUNDING.yml

@@ -1,7 +1,28 @@
-__pycache__
-*.pyc
-.idea
+# Environments
+.env
+.venv
 env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Cache
+**/__pycache__
+.dccache
+
+# PyCharm
+.idea/*
+
+# Visual Studio Code
+.vscode/*
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+# other
+*.pyc
 *.swo
 *.swp
 *.*~
@@ -15,7 +36,5 @@ docs
 build
 dist
 .eggs
-.vscode
 gmon.out
 .vim
-pyproject.toml

.gitignore

@@ -0,0 +1,51 @@
+repos:
+  # update certain features to python 3.9 features
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.16.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py39-plus
+          - --keep-runtime-typing
+
+  # useful pre-commit hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-ast
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  # import statement sorter
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+        args:
+          - --profile=black
+
+  # code formatter
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+        args:
+          - --line-length=120
+          - --target-version=py39
+
+  # code quality analysis
+  - repo: https://github.com/PyCQA/pylint
+    rev: v3.2.4
+    hooks:
+      - id: pylint
+        name: pylint
+        args:
+          - --disable=E0401
+          - --disable=too-many-arguments
+          - --disable=too-few-public-methods
+          - --max-line-length=120
+          - --recursive=y
+          - --ignore-paths=venv*,tests*

.pre-commit-config.yaml

@@ -2,14 +2,12 @@
 
 ## Development Lead
 
-* Daniel Furtado <[email protected]>
+* Nathan Richard <[email protected]>
 
 ## Contributors
 
-* Nick Schober
-* Zoltan Ivanfi
-* Alec Benzer
-* Clint Byrum
-* @johnthangen
+* Be the first to contribute to this repo
 
-See complete list at: https://github.com/dfurtado/dataclass-csv/graphs/contributors
+## Special Thanks
+* Daniel Furtado ([github](https://github.com/dfurtado)) and his python package 'dataclass-csv' ([pypi](https://pypi.org/project/dataclass-csv/) | [github](https://github.com/dfurtado/dataclass-csv)). The most of the Codebase and Documentation is from him and just adjusted for using pydantic.BaseModel.
+* Daniel Seifert ([github](https://github.com/dfseifert)) for the guidance with building a pyproject and reviewing my code <3

.travis.yml

@@ -3,9 +3,6 @@
 I love to work together with people so if you have an excellent idea for a feature, improvements or maybe you found
 a bug. Please, don't hesitate in adding an issue, so we can discuss and find a good solution together.
 
-If you never participated in any open-source project before it is even better! I can help you through the process. The
-important thing is to get more people involved in the Python community. So, don't be shy!
-
 ## Getting started
 
 The best way to get started is to look at the issues section and see if the bug or feature you are planning to work with
@@ -52,9 +49,10 @@ If you get an issue to work on, then you can:
 ## Before you submit a pull request
 
 - Make sure to add unit tests (if applicable)
-- Make sure all tests are passing
-- Run a code formatter. This project uses black, you can run the command: `black -l79 -N -S ./dataclass_csv`
+- Make sure all tests are passing (Note that the CSV files have to use \r\n as newline)
+- Run a code formatter. This project uses black, you can run the command: `black -l 120 -t py39 ./pydantic_csv`
 - Add docstrings for new functions and classes.
+- Make sure you follow the [PEP 8](https://pep8.org/) Style Guide (run the pre-commit)
 
 
 

AUTHORS.md

@@ -1,81 +1,5 @@
 # History
 
-### 0.1.0 (2018-11-25)
+### 0.1.0 (2024-06-28)
 
 * First release on PyPI.
-
-### 0.1.1 (2018-11-25)
-
-* Documentation fixes.
-
-### 0.1.2 (2018-11-25)
-
-* Documentation fixes.
-
-### 0.1.3 (2018-11-26)
-
-* Bug fixes
-* Removed the requirement of setting the dataclass init to `True`
-
-### 0.1.5 (2018-11-29)
-
-* Support for parsing datetime values.
-* Better handling when default values are set to `None`
-
-### 0.1.6 (2018-12-01)
-
-* Added support for reader default values from the default property of the `dataclasses.field`.
-* Added support for allowing string values with only white spaces in a class level using the `@accept_whitespaces` decorator or through the `dataclasses.field` metadata.
-* Added support for specifying date format using the `dataclasses.field` metadata.
-
-### 0.1.7 (2018-12-01)
-
-* Added support for default values from `default_factory` in the field's metadata. This allows adding mutable default values to the dataclass properties.
-
-### 1.0.0 (2018-12-16)
-
-* When a data does not pass validation it shows the line number in the CSV file where the data contain errors.
-* Improved error handling.
-* Changed the usage of the `@accept_whitespaces` decorator.
-* Updated documentation.
-
-### 1.0.1 (2019-01-29)
-
-* Fixed issue when parsing headers on a CSV file with trailing white spaces.
-
-### 1.1.0 (2019-02-17)
-
-* Added support for boolean values.
-* Docstrings
-
-### 1.1.1 (2019-02-17)
-
-* Documentation fixes.
-
-### 1.1.2 (2019-02-17)
-
-* Documentation fixes.
-
-### 1.1.3 (2020-03-01)
-
-* Handle properties with init set to False
-* Handle Option type annotation
-
-### 1.2.0 (2021-03-02)
-
-* Introduction of a DataclassWriter
-* Added type hinting to external API
-* Documentation updates
-* Bug fixes
-
-## 1.3.0 (2021-04-10)
-
-* Included stub files
-* check if the CSV file has duplicated header values
-* Fixed issues #22 and #33
-* code cleanup
-
-## 1.4.0 (2021-12-13)
-
-* Bug fixes
-* Support for date types

CONTRIBUTING.md

@@ -1,5 +1,3 @@
-
-
 BSD License
 
 Copyright (c) 2018, Daniel Furtado
@@ -29,4 +27,3 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
-