Add github workflow actions.

Renamed package to kof-parser.
Updated README.md

Author: josteinl

.github/workflows/branch.yaml

@@ -0,0 +1,60 @@
+name: Push
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.1.14']
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install dependencies
+        run: poetry install
+      - name: Run tests
+        run: poetry run pytest --cov=./ --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+  code-quality:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.1.14']
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install dependencies
+        run: poetry install
+      - name: Run black
+        run: poetry run black . --check
+#      - name: Run isort
+#        run: poetry run isort . --check-only --profile black
+#      - name: Run flake8
+#        run: poetry run flake8 .
+      - name: Run mypy
+        run: poetry run mypy .
+      - name: Run bandit
+        run: poetry run bandit .
+      - name: Run safety
+        run: poetry run safety check
+      - name: Check for acceptable licenses
+        run: poetry run pip-licenses --allow-only="MIT License;BSD License;Python Software Foundation License;Apache Software License;Mozilla Public License 2.0 (MPL 2.0);GNU Library or Lesser General Public License (LGPL)"

.github/workflows/release.yaml

@@ -0,0 +1,30 @@
+name: Release
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  publish:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.9']
+        poetry-version: ['1.1.14']
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run image
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish --build

README.md

@@ -1,8 +1,14 @@
 # NGI KOF Parser
 
 [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![security: safety](https://img.shields.io/badge/security-safety-yellow.svg)](https://github.com/pyupio/safety)
+[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![python](https://img.shields.io/badge/Python-3.9-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
 
-This is the NGI Python package for parsing kof files.
+
+
+Python package for parsing KOF files.
 
 References:
 
@@ -11,21 +17,22 @@ NORWEGIAN GEOTECHNICAL SOCIETY
 SYMBOLER OG DEFINISJONER I GEOTEKNIKK](http://ngf.no/wp-content/uploads/2015/03/2_NGF-ny-melding-2-endelig-utgave-2011-12-04-med-topp-og-bunntekst-Alt-3.pdf)
 - [Norkart KOF specification](http://www.anleggsdata.no/wp-content/uploads/2018/04/KOF-BESKRIVELSE-Oppdatert2005.pdf)
 
-Latest releases see [CHANGES.md](CHANGES.md)
+Latest releases see [CHANGES.md](https://github.com/norwegian-geotechnical-institute/kof-parser/blob/main/CHANGES.md)
 
 # Installation (end user) 
 
 ```bash
 
-pip install ngi-kof-parser
+pip install kof-parser
 
 ```
 
 ## Basic usage
 
 ### Read a kof file
+
 ```python
-from ngi_kof_parser import KOFParser
+from kof_parser import KOFParser
 
 parser = KOFParser()
 
@@ -35,7 +42,7 @@ srid = 5110
 locations = parser.parse('tests/data/test.kof', result_srid=srid, file_srid=srid)
 
 for location in locations:
-   print(location)
+    print(location)
 
 # Output:
 # name='SMPLOC1' methods=[] point_easting=112892.81 point_northing=1217083.64 point_z=1.0 srid=5110
@@ -51,23 +58,23 @@ for location in locations:
 ### Write a kof file
 
 ```python
-from ngi_kof_parser import KOFWriter
-from ngi_kof_parser import Location
+from kof_parser import KOFWriter
+from kof_parser import Location
 
 kof_writer = KOFWriter()
 
 srid = 5110
 locations = [Location(name='SMPLOC1', point_easting=112892.81, point_northing=1217083.64, point_z=1.0),
              Location(name='SMPLOC2', point_easting=112893.15, point_northing=1217079.46, point_z=2.0, methods=['TOT']),
-             Location(name='SMPLOC3',point_easting=112891.88, point_northing=1217073.01, point_z=0.0, methods=['CPT'])]
- 
+             Location(name='SMPLOC3', point_easting=112891.88, point_northing=1217073.01, point_z=0.0, methods=['CPT'])]
+
 kof_string = kof_writer.writeKOF(
     project_id='project_id', project_name='cool-name', locations=locations, srid=srid
 )
 
 print(kof_string)
 # Output:
-# 00 KOF Export from NGI Field Manager
+# 00 KOF Export from NGI's KOF parser
 # 00 Project: project_id. Name: cool-name
 # 00 Spatial Reference ID (SRID): 5110
 # 00 Export date (UTC): 2022-08-22 13:49:44.394607
@@ -104,53 +111,22 @@ There are several combinations of how to set up a local development environment.
 
 We use Poetry for dependency management. See [Install poetry](https://python-poetry.org/docs/) if needed.
 
-To set up a local development environment on you local machine, make sure you have set up your NGI credentials.
-You need to generate Personal Access Token (PAT). Follow
-[this guide](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate)
-for how to get a PAT via the Azure DevOps GUI. `Packaging (Read)` access is sufficient.
-
-After generating the PAT, run this command:
-
-    poetry config http-basic.ngi-fm build <PAT>
-
 Then, from the project root folder run:
 
     poetry install
 
 
-
 # Build and Test
 
 Run in the project root folder: 
 
     poetry install
-    pytest 
+    poetry run pytest 
 
 Build the package wheel: 
 
     poetry build
 
+# Contribute
 
-# Publish
-
-To publish the package to NGI's private Azure Artifacts repository set the following configuration: 
-
-    poetry config repositories.ngi https://pkgs.dev.azure.com/ngi001/277b2f77-691a-4d92-bd89-8e7cac121676/_packaging/fieldmanager/pypi/upload
-
-To publish the package to Azure Artifacts, make sure you have set up your NGI credentials.
-
-You need to generate Personal Access Token (PAT). Follow
-[this guide](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate)
-for how to get a PAT via the Azure DevOps GUI. `Packaging (Read, write, & manage)` access is sufficient.
-
-If you want to publish your newly built package you need to set your NGI credentials: 
-
-    poetry config pypi-token.ngi <PAT>
-
-    poetry publish -r ngi
-
-# TODOs
-
-- Add tests
-- Extend with position transformation from file data srid (input) to project srid (output)
-- Extend with position transformation from file srid (input) to new output fields in wgs84 
+Please start by adding an issue before submitting any pull requests.