Merge pull request #2 from ACornuIGN/dev

Pink_Lady structure beginning, reading et writing opk file

.github/workflows/lint_python.yml

@@ -0,0 +1,36 @@
+name: Lint_python
+
+on:
+  push:
+    branches: [main]
+    tags:
+  pull_request:
+
+jobs:
+  lint_python:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.10.13
+        architecture: 'x64'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint flake8
+
+    - name: Analysing the code with pylint
+      run: |
+        pylint pink_lady.py src/reader/manage_reader.py src/reader/reader_opk.py src/shot.py src/worksite.py src/writer/writer.py
+
+      continue-on-error: true
+
+    - name: Analysing the code with flake8
+      run: |
+        flake8  --max-line-length 100 pink_lady.py src/reader/manage_reader.py src/reader/reader_opk.py src/shot.py src/worksite.py src/writer/writer.py
+

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: unitary_test
+
+on:
+  pull_request:
+    branches: 
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - name: Checkout branch
+      uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-shutil
+
+    - name: Run tests with pytest
+      with:
+        environment-file: environment.yml
+      run: python3 -m pytest -s ./test -v

.gitignore

@@ -69,7 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+#docs/_build/
 
 # PyBuilder
 .pybuilder/

README.md

@@ -1,5 +1,26 @@
-# Welcome to Pink Lady
+# Welcome to Pink Lady !!!
 
 Pink Lady is a photogrammetric conversion and acquisition program in .OPK format. Open-source with a few tools, such as calculation of the position in the image (l,c) of a terrain point (X,Y,Z).
 
-First step: reading and writing an .OPK file and set up the associated tests
+### Commit Message Header
+
+```
+<type>: <short summary>
+  │            │
+  │            └─⫸ Summary in present tense. Not capitalized. No period at the end.
+  │
+  └─⫸ Commit Type: build|docs|fix|refactor|test|clean|lint
+```
+
+### HTML documentation
+
+Html documentation in docs/_build/html/index.hmlt
+
+### Functionality
+
+1. Reading and writing an OPK file
+2. Restructuring of read files to allow the addition of read files without modifying functions
+    Structure file in reader folder: 
+      - name : reader_ext.py
+      - function : def read(file: str) -> Worksite:
+3. Reading a camera file (XML and txt)

ci/test.sh

@@ -0,0 +1 @@
+python3 -m pytest -s ./test -v

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f03d3f65f8574fccd2076660daad4aa7
+tags: 645f666f9bcd5a90fca523b33c5a78b7