Merge pull request #480 from LAAC-LSCP/cmdline/init

docs and test cli call for init command

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+- docs and tests for init command
+
 ## [0.2.2] 2024-06-26
 
 ### Added

docs/source/tools.rst

@@ -1,6 +1,22 @@
 Basic tools
 ===========
 
+Dataset initialization
+----------------------
+
+This command allows you to create a new and empty dataset, with the correct structure
+
+.. clidoc::
+
+   child-project init /path/to/dataset --help
+
+Example:
+
+.. code:: bash
+
+   # create a dataset in a folder named mydataset
+   child-project init mydataset
+
 .. _tools-data-validation:
 
 Data validation

tests/test_cli.py

@@ -41,6 +41,14 @@ def test_overview(project):
     assert exit_code == 0
 
 
+def test_init():
+    shutil.rmtree(PATH, ignore_errors=True)
+    stdout, stderr, exit_code = cli(
+        ["child-project", "init", PATH]
+    )
+    assert exit_code == 0
+
+
 def test_import_annotations(project):
     stdout, stderr, exit_code = cli(
         [