WIP: Octave packaging.

.gitignore

 # General
 build/
-include/libcaosdbConfig.h
+*.tar.gz
+
+# Caches
+.*cache
 
 # CMake
 CMakeLists.txt.user

Makefile

@@ -32,7 +32,12 @@ doc:
 .PHONY: style
 style:
 	mh_style --octave src
+	mh_style --octave pkg
 
 .PHONY: test
 test:
 	cd src && octave Run_Test.m
+
+.PHONY: pkg
+pkg:
+	tar -czf caosdb.tar.gz --exclude-from=.gitignore pkg

pkg/.miss_hit

+# -*- mode:conf; -*-
+# See https://florianschanda.github.io/miss_hit/style_checker.html
+
+line_length: 100
+regex_function_name: "[a-z]+(_[a-z]+)*"
+suppress_rule: "whitespace_comments"
+tab_width: 2

pkg/CITATION

+caosdb-octavelib, an Octave library for CaosDB. IndiScale GmbH (2021)

src/Example.m → pkg/COPYING

-% (C) Copyright 2021 IndiScale GmbH <info@indiscale.com>
-% (C) Copyright 2021 Daniel Hornung <d.hornung@indiscale.com>
-%
 % This file is a part of the CaosDB Project.
 %
+% Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
+% Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com>
+%
 % This program is free software: you can redistribute it and/or modify
 % it under the terms of the GNU Affero General Public License as
 % published by the Free Software Foundation, either version 3 of the
@@ -15,12 +15,3 @@
 %
 % You should have received a copy of the GNU Affero General Public License
 % along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-%% Example file with dummy code from https://www.gnu.org/software/octave/
-
-x = -10:0.1:10;  % Create an evenly-spaced vector from -10..10
-y = sin(x);      % y is also a vector
-plot (x, y);
-title ("Simple 2-D Plot");
-xlabel ("x");
-ylabel ("sin (x)");

pkg/ChangeLog

+../../CHANGELOG.md
\ No newline at end of file

pkg/DESCRIPTION

+# See https://octave.org/doc/interpreter/The-DESCRIPTION-File.html
+Name: caosdb
+Version: 0.1.0
+Date: 2021-07-09
+Author: Daniel Hornung <d.hornung@indiscale.com>
+Maintainer: Daniel Hornung <d.hornung@indiscale.com>
+Title: Octave and Matlab library for CaosDB
+Description: This package contains utility functions to interact with CaosDB.
+License: AGPLv3
+Categories: data management
+Url: https://gitlab.com/caosdb/caosdb-octavelib
+BuildRequires: libcaosdb

pkg/LICENSE.md

+../../LICENSE.md
\ No newline at end of file

src/doc/Gen_HTML.m → pkg/doc/Gen_HTML.m

@@ -19,5 +19,5 @@
 % ------------------------------------------------------------------------
 % Build the HTML documentation.
 
-pkg load generate_doc
-generate_package_html("caosdb", "_build_octave/")
+pkg load generate_doc;
+generate_package_html("caosdb", "_build_octave/");

pkg/src/configure

+#!/bin/bash
+
+echo "Nothing is implemented yet."
+
+# See https://octave.org/doc/interpreter/Creating-Packages.html

src/Run_Test.m

@@ -19,12 +19,12 @@
 % ------------------------------------------------------------------------
 % Run the tests, exit with their value.
 
-addpath("dummy");
+addpath('../pkg/inst/');
 
 [n, nmax, nxfail, nbug, nskip, nrtskip, nregression] = ...
-  test("some_function.m", "verbose");
+  test('some_function.m', 'verbose');
 
-disp(["Passed " num2str(n) " out of " num2str(nmax) " tests."]);
+disp(['Passed ' num2str(n) ' out of ' num2str(nmax) ' tests.']);
 if n == nmax
   exit(0);
 end