gamslib 0.7.5__tar.gz

gamslib-0.7.5/.gitignore

@@ -0,0 +1,28 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv
+.coverage
+.python-version
+requirements-dev.lock
+requirements.lock
+.vscode/settings.json
+
+
+
+foo.py
+uv.lock
+src/gamslib/validate/xml/X_dtdvalidator.py
+src/gamslib/validate/xml/X_genericxmlvalidator.py
+src/gamslib/validate/xml/X_lidovalidator.py
+src/gamslib/validate/xml/X_teivalidator.py
+tests/validate/xml/X_test_dtdvalidator.py
+tests/validate/xml/data/Xminimal_non_existing_schema_reference.xml
+.DS_Store
+coverage

gamslib-0.7.5/.gitlab-ci.yml

@@ -0,0 +1,56 @@
+variables:
+  UV_VERSION: 0.5
+  PYTHON_BASE_VERSION: 3.12
+  BASE_LAYER: bookworm-slim
+
+stages:
+  - test
+  - lint
+
+
+# A hidden job template that can be used by different Python versions
+.test-template:
+  stage: test
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_BASE_VERSION-$BASE_LAYER
+  script:
+    - echo "uv environment version"
+    - uv --version
+    - echo "Pinning ${PYTHON_VERSION}"
+    - uv python pin ${PYTHON_VERSION}
+    - uv sync
+    - echo "Using python version:"
+    - python --version
+    - echo "Running tests with uv"
+    - uv run pytest tests
+
+
+test-py_3.11:
+  extends: .test-template
+  variables:
+    PYTHON_VERSION: "3.11"
+
+test-py_3.12:
+  extends: .test-template
+  variables:
+    PYTHON_VERSION: "3.12"    
+    
+test-py_3.13:
+  extends: .test-template
+  variables:
+    PYTHON_VERSION: "3.13"    
+
+
+lint:
+  stage: lint
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_BASE_VERSION-$BASE_LAYER  
+  script:
+    - echo "uv environment version"
+    - uv --version
+    - echo "Using python version:"
+    - python --version
+    - echo "Running uv check with ruff"
+    - uv run ruff check src
+
+.rules:
+  - if: $CI_COMMIT_REF_NAME == "main" || $CI_COMMIT_REF_NAME == "develop"
+    when: always

gamslib-0.7.5/CHANGELOG.md

@@ -0,0 +1,152 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.7.5] - 2025-11-21
+
+### Changed
+
+  * Add tags to object.csv
+  
+## [0.7.4] - 2025-11-19
+
+### Changed
+
+ * Add extract_id_from_tei() to objectcsv.utils
+ * Add extract_id_from_lido() to objectcsv.utils
+ * Add check_if_object_dir_matches_object_id() to objectcsv.utils
+
+## [0.7.3] - 2025-11-19
+
+### Changed
+
+  * Allow uppercase letters in datastream ids
+   
+## [0.7.2] - 2025-11-11
+
+  * Add sip.utils.is_bag function
+  * Bump magika to 1.0.1
+  * Improve tests
+  * Fix .gitlab-ci.yml
+   
+## [0.7.1] - 2025-11-10
+
+### Changed
+
+  * Add more file names, which should not be treated as datastreams.
+
+## [0.7.0] - 2025-10-16
+
+### Changed
+  * Add sip submodule 
+  * Add Makefile
+  * Add reference (API documentation)
+    
+## [0.6.1] - 2025-07-23
+
+### Changed
+
+  * Code cleanup
+  * line in datastreams.csv are again saved sorted by dsid
+
+## [0.6.0] - 2025-07-18
+
+### Changed
+
+  * Massively refactored. 
+  * CSV handling was heavily rewritten: objectcsv was replaced by two new 
+    classes: ObjectCSVManager and ObjectCollector
+  * mainResource is set automatically for XML files
+  * title for datastreams now contains the Type and Subtype. This was request from the
+    front end people
+
+
+## [0.5.0] - 2025-02-28
+
+### Changed
+
+   * Breaking change: The subtype property of FormatInfo classes 
+     is no longer a string, but a formatinfo.SubType enum value.
+     This gives more control about supported subtypes and avoids
+     mistakes.
+
+
+## [0.4.3] - 2025-02-20
+
+### Changed
+
+   * get_languages() in create_csv.py no longer supports data from DC.xml,
+     because 'language' of the object does not say anything about the language
+     of a data stream. 
+
+## [0.4.2] - 2025-02-20
+
+### Added
+
+* Add a detect_languages to create_csv.py
+  * Currently language(s) are taken from DC.xml
+  * NLP based detection can be added later
+
+## Removed
+
+* Remove the 'funder' field from datastreams.csv, which was introduced 
+  in 0.4.1, because it was highly redundant. 'funder' now is only
+  supported in object.csv
+
+
+## [0.4.1] - 2025-02-20
+
+### Changed
+* Add a 'funder' field to object.csv and datastreams.csv
+
+## [0.4.0] - 2025-01-30
+
+### Added
+
+* A new subpackage formatdetect for file format identification 
+
+### Changed
+
+* project.toml has 2 new fields in the general table: format_detector and format_detector_url
+* Add tags column to datastreams.csv
+* Improve auto-detection for some csv columns
+* The Configuration object in submodule projectconfiguration now must be obtained by calling
+  the (cached) get_configuration() function
+
+## [0.3.1] - 2025-01-09
+
+### Changed
+
+* Additional filename pattterns for autogenerating values  title and description are
+    autogenerated 
+* Default titles for media files (images, audio, video): 'Image|Audio|Video: DS ID'
+
+
+
+## [0.3.0] - 2024-12-13
+
+### Changed
+
+- manage_csv.py: The collected csv files are now by default created 
+   and expected in the current working directory and no longer in object_root
+- collect_csv_data() output_dir ist now a required parameter: 
+- Unify/simplify API
+- manage_csv.collect_csv_data() now requires the output_dir parameter 
+- When creating the csv files, some fields like title and description are
+  autogenerated
+
+
+## [0.2.6] - 2024-12-06
+
+### Added
+
+- CHANGELOG.md
+- More tests
+
+### Changed
+
+- Extend pyproject.toml
+  

gamslib-0.7.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fabio Tosques, Gunter Vasold
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gamslib-0.7.5/Makefile

@@ -0,0 +1,30 @@
+# make test, coverage, documentation, etc
+SHELL := /bin/bash
+
+.PHONY: all test coverage clean docs build test-all
+
+docs:
+	@echo "Generating documentation..."
+	@pdoc3 --html --output-dir reference --force gamslib
+	@echo "Documentation generated in the 'reference' directory."
+
+
+test:
+	@uv run pytest tests 
+
+# Run all tests with different python versions
+test-versions:
+	@uv run --python 3.11 --isolated --with-editable '.[test]' pytest
+	@uv run --python 3.12 --isolated --with-editable '.[test]' pytest
+	@uv run --python 3.13 --isolated --with-editable '.[test]' pytest
+# 3.14 depencies currently have some wheel issues: magicka require 1.20, which is rather old
+	# @uv run --python 3.14 --isolated --with-editable '.[test]' pytest
+
+lint:
+	@uv run ruff check src  
+
+coverage:
+	@uv run pytest tests --cov-report term-missing --cov=gamslib 
+
+build:
+	@uv build	

gamslib-0.7.5/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: gamslib
+Version: 0.7.5
+Summary: Modules and subpackages used in various GAMS5 related projects
+Project-URL: Homepage, https://github.com/DHGraz/gamslib
+Project-URL: Repository, https://github.com/DHGraz/gamslib
+Project-URL: Issues, https://github.com/DHGraz/gamslib/issues
+Project-URL: Changelog, https://github.com/DHGraz/gamslib/blob/main/CHANGELOG.md
+Author-email: Gunter Vasold <gunter.vasold@uni-graz.at>, Fabio Tosques <fabio.tosques@uni-graz.at>
+License-File: LICENSE
+Keywords: GAMS
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.25.1
+Requires-Dist: lxml>=6.0.2
+Requires-Dist: magika>=1.0.1
+Requires-Dist: pydantic>=2.12.2
+Requires-Dist: pylightxl>=1.61
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: requests>=2.32.5
+Requires-Dist: rnc2rng>=2.7.0
+Requires-Dist: tomlkit>=0.13.3
+Requires-Dist: uritools>=5.0.0
+Description-Content-Type: text/markdown
+
+# gamslib
+
+Gamslib is a collection of GAMS related modules and packages, which are used in multiple other packages.
+
+## Installation
+
+gamslib is available on pypi.org and can be installed via pip:
+
+```
+pip install gamslib
+```
+
+## Usage
+
+As gamslib is a library, it can only we used with other code. 
+
+The main purpose is to make code reusable in other GAMS5 projects and to have
+a unique way of doing things. If you are not working on GAMS5 reated code
+(which is very likely), this library will be useless for you.
+
+Currently these subpackages are available (more to come):
+
+## objectcsv
+
+Handle object and datastream metadata in object csv files.
+
+When creating bags for GAMS, we provide some metadata in csv
+files (which are not part of the bag, btw).
+
+The objectcsv package provides tools to handle this metadata.
+
+  * The ObjectCSV class represents the object    and datastream csv data for a
+    single object. It is created by providing the path to the  object
+    directory. 
+  * The manage_csv module can be used to collect csv data from all objects into
+    a single file, which makes editing the data more efficient. It also has a
+    function to update the csv files in the object directories based on the
+    collected data.
+  * The xlsx module can be used to convert the csv files to xlsx files and vice
+    versa. This is useful for editing the data in a spreadsheet without the
+    hassles of importing and exporting the csv files, which led to encoding
+    problems in the past.
+
+## projectconfiguration
+
+This package contains a central class `Configuration` that represents the
+project configuration. To create this object, the function
+`load_configuration(OBJECT_ROOT, [PATH_TO_TOML_FILE])` should be used.
+
+The function tries to find the project configuration file, validates its
+content, and creates the central Configuration object with all sub-objects
+(Each TOML inline table is provided as its own sub-object). These sub-objects
+are currently:
+
+  * general
+  * metadata
+
+A basic configuration file can be generated via the `create_condiguration()`
+function.
+
+
+## Contributing
+
+The Github repository is ment to be a read only mirror of the work repository
+hosted on our institutional private Github server. You can use the bug tracker
+on Github, but everything else should happen in the Zimlab Github repo.
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

gamslib-0.7.5/README.md

@@ -0,0 +1,71 @@
+# gamslib
+
+Gamslib is a collection of GAMS related modules and packages, which are used in multiple other packages.
+
+## Installation
+
+gamslib is available on pypi.org and can be installed via pip:
+
+```
+pip install gamslib
+```
+
+## Usage
+
+As gamslib is a library, it can only we used with other code. 
+
+The main purpose is to make code reusable in other GAMS5 projects and to have
+a unique way of doing things. If you are not working on GAMS5 reated code
+(which is very likely), this library will be useless for you.
+
+Currently these subpackages are available (more to come):
+
+## objectcsv
+
+Handle object and datastream metadata in object csv files.
+
+When creating bags for GAMS, we provide some metadata in csv
+files (which are not part of the bag, btw).
+
+The objectcsv package provides tools to handle this metadata.
+
+  * The ObjectCSV class represents the object    and datastream csv data for a
+    single object. It is created by providing the path to the  object
+    directory. 
+  * The manage_csv module can be used to collect csv data from all objects into
+    a single file, which makes editing the data more efficient. It also has a
+    function to update the csv files in the object directories based on the
+    collected data.
+  * The xlsx module can be used to convert the csv files to xlsx files and vice
+    versa. This is useful for editing the data in a spreadsheet without the
+    hassles of importing and exporting the csv files, which led to encoding
+    problems in the past.
+
+## projectconfiguration
+
+This package contains a central class `Configuration` that represents the
+project configuration. To create this object, the function
+`load_configuration(OBJECT_ROOT, [PATH_TO_TOML_FILE])` should be used.
+
+The function tries to find the project configuration file, validates its
+content, and creates the central Configuration object with all sub-objects
+(Each TOML inline table is provided as its own sub-object). These sub-objects
+are currently:
+
+  * general
+  * metadata
+
+A basic configuration file can be generated via the `create_condiguration()`
+function.
+
+
+## Contributing
+
+The Github repository is ment to be a read only mirror of the work repository
+hosted on our institutional private Github server. You can use the bug tracker
+on Github, but everything else should happen in the Zimlab Github repo.
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

gamslib-0.7.5/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "gamslib"
+version = "0.7.5"
+description = "Modules and subpackages used in various GAMS5 related projects"
+authors = [
+    { name = "Gunter Vasold", email = "gunter.vasold@uni-graz.at" },
+    { name = "Fabio Tosques", email = "fabio.tosques@uni-graz.at" }
+]
+dependencies = [
+    "pylightxl>=1.61",
+    "pydantic>=2.12.2",
+    "python-dotenv>=1.1.1",
+    "lxml>=6.0.2",
+    "requests>=2.32.5",
+    "uritools>=5.0.0",
+    "tomlkit>=0.13.3",
+    "rnc2rng>=2.7.0",
+    "jsonschema>=4.25.1",
+    "magika>=1.0.1",
+]
+readme = "README.md"
+requires-python = ">= 3.11"
+keywords = ["GAMS"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[project.urls]
+Homepage = "https://github.com/DHGraz/gamslib"
+# Documentation = "https://readthedocs.org"
+Repository = "https://github.com/DHGraz/gamslib"
+Issues = "https://github.com/DHGraz/gamslib/issues"
+Changelog = "https://github.com/DHGraz/gamslib/blob/main/CHANGELOG.md"
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-datadir>=1.8.0",
+    "pytest-cov>=7.0.0",
+    "toml>=0.10.2",
+    "ruff>=0.14.0",
+    "pylint>=4.0.1",
+    "pyright>=1.1.406",
+    "pdoc3>=0.11.6",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gamslib"]
+
+[tool.ruff.lint]
+select = ["PL", "RUF", "SIM"]
+