majis-ops 1.0.0__tar.gz

majis_ops-1.0.0/.gitignore

@@ -0,0 +1,145 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+pythonenv*
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# profiling data
+.prof
+
+# End of https://www.toptal.com/developers/gitignore/api/python

majis_ops-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,180 @@
+image: python:3.10
+
+stages:
+  - linter
+  - tests
+  - deploy
+
+# Rules aliases
+.rules_py_changes: &rules_py_changes
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+    - if: '$CI_MERGE_REQUEST_ID'
+      changes:
+        - src/**/*.py
+        - tests/**/*.py
+        - .gitlab-ci.yml
+
+.rules_py_changes_no_mr_draft: &rules_py_changes_no_mr_draft
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+    - if: '$CI_MERGE_REQUEST_ID && $CI_MERGE_REQUEST_TITLE !~ /^Draft:/'
+      changes:
+        - src/**/*.py
+        - tests/**/*.py
+        - .gitlab-ci.yml
+
+.rules_docs_changes: &rules_docs_changes
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+    - if: '$CI_MERGE_REQUEST_ID'
+      changes:
+        - docs/**/*
+        - .gitlab-ci.yml
+
+.rules_version_changes: &rules_version_changes
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH'
+      changes:
+        - src/majis/__version__.py
+
+# Cache configuration
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+
+cache:
+  key: "${CI_JOB_NAME}"
+  paths:
+    - .cache/pip
+    - .venv
+
+# Install Hatch by default
+default:
+  before_script:
+    - python -m pip install "hatch>=1.12"
+
+# Linter
+Ruff:
+  stage: linter
+  <<: *rules_py_changes
+  script:
+    - hatch -e linter run check
+    - hatch -e linter run format
+
+# Tests
+.pytest: &pytest
+  stage: tests
+  script:
+    - hatch -e tests run tests
+      --cov-report xml:coverage.xml
+      --junitxml=report.xml
+  coverage: '/^TOTAL\s+\d+\s+\d+\s+(\d+\%)$/'
+  artifacts:
+    expire_in: 1 week
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+Pytest 3.10:
+  <<: *rules_py_changes
+  <<: *pytest
+
+Pytest 3.11:
+  image: python:3.11
+  <<: *rules_py_changes_no_mr_draft
+  <<: *pytest
+
+Pytest 3.12:
+  image: python:3.12
+  <<: *rules_py_changes_no_mr_draft
+  <<: *pytest
+
+# Build docs
+Docs:
+  stage: tests
+  <<: *rules_docs_changes
+  script:
+    - hatch -e docs run build
+
+# Deployment
+ReadTheDocs:
+  stage: deploy
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^(v|V)?(\d+)(\.\d+)+?$/ && $RTD_URL && $RTD_TOKEN'
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH && $RTD_URL && $RTD_TOKEN'
+  cache: {}
+  before_script: []
+  script:
+    - curl -X POST -d "branches=$CI_COMMIT_REF_NAME" -d "token=$RTD_TOKEN" $RTD_URL
+  environment:
+    name: ReadTheDocs
+    url: https://majis-ops.readthedocs.io/en/$CI_COMMIT_REF_NAME
+
+PyPI:
+  stage: deploy
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^(v|V)?(\d+)(\.\d+)+?$/ && $PYPI_TOKEN'
+  variables:
+    HATCH_INDEX_USER: __token__
+    HATCH_INDEX_AUTH: $PYPI_TOKEN
+  script:
+    - hatch publish
+  environment:
+    name: PyPI
+    url: https://pypi.org/project/majis-ops/
+
+SWH:
+  stage: deploy
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^(v|V)?(\d+)(\.\d+)+?$/'
+  cache: {}
+  before_script: []
+  script:
+    - curl -X POST https://archive.softwareheritage.org/api/1/origin/save/git/url/${CI_PROJECT_URL}/
+  environment:
+    name: Software Heritage
+    url: https://archive.softwareheritage.org/browse/origin/?origin_url=${CI_PROJECT_URL}
+
+# Release
+Prepare release:
+  stage: deploy
+  <<: *rules_version_changes
+  script:
+    - echo "VERSION=$(hatch version)" > variables.env
+    - echo "DATE=$(date +'%Y/%m/%d')" >> variables.env
+    - awk "/releases/{found=1;next}found" CHANGELOG.md | awk "/\[Release/{exit}1" > Release_description.md
+  artifacts:
+    paths:
+      - Release_description.md
+    reports:
+      dotenv: variables.env
+
+Publish release:
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  stage: deploy
+  <<: *rules_version_changes
+  needs:
+    - job: 'Prepare release'
+      artifacts: true
+  cache: {}
+  before_script: []
+  script:
+    - echo "Version ${VERSION} - ${DATE}"
+    - cat ./Release_description.md
+  release:
+      name: 'Version ${VERSION} - ${DATE}'
+      description: ./Release_description.md
+      tag_name: ${VERSION}
+      tag_message: 'Version ${VERSION} - ${DATE}'
+      ref: '$CI_COMMIT_SHA'
+      assets:
+        links:
+          - name: 'PyPI'
+            url: 'https://pypi.org/project/majis-ops/${VERSION}/'
+            link_type: package
+          - name: 'Documentation'
+            url: 'https://majis-ops.readthedocs.io/en/${VERSION}'
+          - name: 'Software Heritage'
+            url: 'https://archive.softwareheritage.org/browse/origin/directory/?origin_url=${CI_PROJECT_URL}&release=${VERSION}'

majis_ops-1.0.0/.readthedocs.yaml

@@ -0,0 +1,22 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  jobs:
+    pre_build:
+      - pip install jupyter-book
+      - jupyter-book config sphinx docs/
+
+python:
+  install:
+    - method: pip
+      path: .
+
+sphinx:
+  builder: html
+  fail_on_warning: true
+
+formats:
+  - pdf

majis_ops-1.0.0/.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+    "python.testing.pytestArgs": [
+        "tests",
+        "--no-cov",
+        "-vv",
+        "--color=no"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "cSpell.words": [
+        "funcs",
+        "maxsplit",
+        "openpyxl",
+        "perijove",
+        "Poulet",
+        "xtlm"
+    ],
+    "liveServer.settings.root": "docs/_build/html",
+    "python.testing.pytestPath": ".venv/tests/bin/pytest"
+}

majis_ops-1.0.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# MAJIS operations toolbox history
+
+All notable changes to MAJIS operations toolbox will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+[Unreleased][new]
+-----------------
+[new]: https://git.ias.u-psud.fr/majis_sgs/operations/majis-ops-toolbox/-/compare/1.0.0...main
+
+
+[Release 1.0.0 - 2024/06/19][1.0.0]
+-----------------------------------
+[1.0.0]: https://juigitlab.esac.esa.int/python/planetary-coverage/-/releases/1.0.0
+
+### Added
+
+- Add `read_itl()`, `save_itl()`, `save_csv()` and `save_xlsm()` methods.
+- Add `Timeline` object to manipulate MAJIS `.xlsm` timeline file.
+- Add `majis-itl` command line interface.
+- Project init