Initializing a fresh pyproject.toml (#71)

* Initializing a fresh pyproject.toml

Upgrading package structure.

* Updating ci reference to branch main

* Moving package's metadata to pyproject.toml

* fix: Missing a version

* Moved dependencies

* Migrated testing requirements to pyproject.toml

* Moving other optionals

* Project's URL

* Moving console script definition

* How the version is defined

* Seting up black for 88 line-length

* Using dynamic versioning

* Cleaning everything related to hardcoded version

* Keeping Py-3.6 for a little bit longer

It took me so long to update this, now I should at least give some.
There is a chance of someone stuck on older versions because of this.

* fix: Just use float instead

* Updating history

* Testing with Py-3.8

* Testing with 3.9 & 3.10

* fix: encoding for json.loads is deprecated

* Don't fail-fast so it is easier to debug

* Updating code syntax

* style: Applying black

* style: More formating with black

* Updating GA Python setup

* style: More work improving code style

* Adding pre-commit setup

This is probably what will be used.

Upgrade pyupgrade standard once stop supporting Py3.6

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: pySeabird
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
   schedule:
     - cron: "7 18 * * 0"
 
@@ -14,14 +14,17 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ["3.7"]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 

.gitignore

@@ -11,6 +11,7 @@ parts
 sdist
 develop-eggs
 .installed.cfg
+version.py
 
 # Installer logs
 pip-log.txt

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+    python: python3.10
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-ast
+    -   id: check-docstring-first
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: check-toml
+    -   id: debug-statements
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v2.38.2
+    hooks:
+    -   id: pyupgrade
+        args: [--py36-plus]
+-   repo: https://github.com/psf/black
+    rev: 22.8.0
+    hooks:
+    -   id: black
+        args: [ --safe ]
+        exclude: docs/conf.py
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+0.12.x
+------
+
+* Upgrading package structure. Before it was still an early Python-3 structure
+  that limited to Python<3.8
+
 0.11.x
 ------
 
@@ -100,7 +106,7 @@ History
 
 * When position available in the header.intro as NMEA, load this instead of
     try to parse from the header.notes.
-* Load default values from a yaml file, like attributes{cruise, project, 
+* Load default values from a yaml file, like attributes{cruise, project,
     shipname ...}
 * Using a recommended variable names list
 
@@ -121,3 +127,12 @@ History
 
 * Initial import.
 * It's able to load the variables into Masked Array, but it's not the best way to do it.
+
+pre-0.1
+-------
+
+This package was derived from what is now CoTeDe. It had a different name at
+that time. Gui re-structure it in 2006 into a consistent Python package to
+quality control TSG at NOAA/AOML. Operating with different models of TSGs and
+different versions of outputs, it was crucial to parse and normalize those
+into a consistent data model for a standard QC procedure.

README.rst

@@ -52,7 +52,7 @@ To install:
     pip install seabird
 
 
-One way to use is running on the shell the cnvdump. Independent of the historical version of the cnv file, it will return a default structure: 
+One way to use is running on the shell the cnvdump. Independent of the historical version of the cnv file, it will return a default structure:
 
     seabird cnvdump your_file.cnv