Merged PR 2556: Release 0.0.6

- Merged PR 2463: Add KOF writer
- Merged PR 2471: Add handling of admin block (01)
- Merged PR 2488: Add new methods. revised default and OTHER handling
- Merged PR 2522: Add transformations during parsing of kof files.
- Add authentication to our private pypi (azure artifiacts).
- Add onlyAddExtraIndex for the authentication to our private pypi (azure artifiacts).
- Upgrade to typed version of ngi-projector package.
- Forgot the lock file.
- Use the new ngi-projector version 0.0.3 with new Projector.transform() method signature.

Related work items: #5559, #5972, #6068

Author: josteinl

.gitattributes

@@ -0,0 +1,5 @@
+# This .gitattributes file primarily made for the test files. Some test files are deliberatly constructed with wrong
+# line endings for test purposes and should be specified here.
+
+# Don't let git modify the end-of-line characters:
+*.[Kk][Oo][Ff] binary

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+test-output.xml
 
 # Translations
 *.mo

CHANGES.md

@@ -1,6 +1,41 @@
-# NGI Python KOF Parser
+# NGI Python KOF Parser Package
 
-## Version 0.0.1
+## Version 0.0.6
+_2022-03-02_
 
+Add
+
+- Use new ngi-projector version 0.0.3. 
+- Add transformations.
+- Support for more methods. Complete list:        
+   - RO: 2251
+   - RW: 2401
+   - SA: 2402
+   - TP: 2403
+   - SS: 2405
+   - RP: 2406
+   - CPT: 2407
+   - RS: 2409
+   - SR: 2410
+   - SPT: 2411
+   - RCD: 2412
+   - PZ: 2413
+   - PT: 2414 
+   - SVT: 2415
+   - INC: 2417
+   - TOT: 2418
+- Support parsing of letter tema codes F, VB and GVR.
+- KOF Writer for creating KOF files.
+- Add coordinate system handling in the admin block (01).
+
+
+## Version 0.0.5
+_2022-02-10_
+
+
+## Version 0.0.3
+_2022-01-31_
+
+- Initial version
 
 

README.md

@@ -1,5 +1,7 @@
 # NGI KOF Parser
 
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+
 This is the NGI Python package for parsing kof files.
 
 References:
@@ -21,14 +23,17 @@ pip install ngi-kof-parser
 
 ## Basic usage
 
+### Read a kof file
 ```python
 from ngi_kof_parser import KOFParser
 
 parser = KOFParser()
 
 # ETRS89/NTM10:
 srid = 5110
-locations = parser.parse('tests/data/test.kof', srid)
+# Please note that the parser do not handle any coordinate system transformations,
+# so you need to use the same input and output SRIDs (for now).
+locations = parser.parse('tests/data/test.kof', result_srid=srid, file_srid=srid)
 
 for location in locations:
    print(location)
@@ -44,19 +49,74 @@ for location in locations:
 
 ```
 
+### Write a kof file
+
+```python
+from ngi_kof_parser import KOFWriter
+from ngi_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'])]
+ 
+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 Project: project_id. Name: cool-name
+# 00 Spatial Reference ID (SRID): 5110
+# 00 Export date (UTC): 2022-02-17 13:23:43.204875
+# 00 Oppdrag      Dato     Ver K.sys   Komm $21100000000 Observer    
+# 01 cool-name    17022022   1     210      $21100000000             
+# 05 SMPLOC1             112892.810   1217083.640 1.000                
+# 05 SMPLOC2    2418     112893.150   1217079.460 2.000                
+# 05 SMPLOC3    2407     112891.880   1217073.010 0.000                
+```
+
 # Getting Started developing
 
 1. Software dependencies
 
+2. Clone this repository
+
+3. Install
+
+## Software dependencies
+
+Before you start, install:
+
    - Python 3.9 or higher
    - Poetry
    - black code formatter
+   
+## Clone this repository
 
-2. Clone this repository
+Use git to clone this repository.
 
-3. Install
+## Install
 
-   `poetry install`
+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
 
 
 

azure-pipelines.yml

@@ -16,13 +16,26 @@ steps:
       versionSpec: "3.9"
     displayName: "Use Python 3.9"
 
+  - task: PipAuthenticate@1
+    displayName: 'Pip Authenticate'
+    inputs:
+      artifactFeeds: '277b2f77-691a-4d92-bd89-8e7cac121676/fieldmanager'
+      onlyAddExtraIndex: True
+
+
   - script: |
       python -m pip install --upgrade pip
       pip install poetry
       pip install twine
+      export PAT=$(echo "$PIP_EXTRA_INDEX_URL" | sed 's/.*build:\(.*\)@pkgs.*/\1/')
+      poetry config http-basic.ngi-fm build "$PAT"
       poetry install
     displayName: "Install dependencies"
 
+  - script: |
+      poetry run bandit -r src
+    displayName: "bandit"
+
   - script: |
       poetry run mypy .
     displayName: "mypy"