datalad · adswa · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -62,23 +62,23 @@ environment:
 
     # Ubuntu core tests
     - ID: Ubu20
-      DTS: datalad_helloworld
+      DTS: datalad_ria
       APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004
       INSTALL_SYSPKGS: python3-virtualenv
       # system git-annex is way too old, use better one
-      INSTALL_GITANNEX: git-annex -m deb-url --url http://snapshot.debian.org/archive/debian/20210906T204127Z/pool/main/g/git-annex/git-annex_8.20210903-1_amd64.deb
+      INSTALL_GITANNEX: git-annex -m snapshot
       CODECOV_BINARY: https://uploader.codecov.io/latest/linux/codecov
     # Windows core tests
     - ID: WinP39core
       # ~35 min
-      DTS: datalad_helloworld
+      DTS: datalad_ria
       APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
       # Python version specification is non-standard on windows
       PY: 39-x64
       INSTALL_GITANNEX: git-annex -m datalad/packages
     # MacOS core tests
     - ID: MacP38core
-      DTS: datalad_helloworld
+      DTS: datalad_ria
       APPVEYOR_BUILD_WORKER_IMAGE: macos-monterey
       PY: 3.8
       INSTALL_GITANNEX: git-annex
@@ -197,8 +197,8 @@ test_script:
   - cmd: md __testhome__
   - sh: mkdir __testhome__
   - cd __testhome__
-  - cmd: python -m pytest -s -v -m "not (turtle)" --doctest-modules --cov=datalad_helloworld --pyargs %DTS%
-  - sh:  python -m pytest -s -v -m "not (turtle)" --doctest-modules --cov=datalad_helloworld --pyargs ${DTS}
+  - cmd: python -m pytest -s -v -m "not (turtle)" --doctest-modules --cov=datalad_ria --pyargs %DTS%
+  - sh:  python -m pytest -s -v -m "not (turtle)" --doctest-modules --cov=datalad_ria --pyargs ${DTS}
 
 
 after_test:

diff --git a/.gitattributes b/.gitattributes
@@ -1 +1 @@
-datalad_helloworld/_version.py export-subst
+datalad_ria/_version.py export-subst
diff --git a/.github/workflows/test_crippledfs.yml b/.github/workflows/test_crippledfs.yml
@@ -52,4 +52,4 @@ jobs:
         echo "== mount >>"
         mount
         echo "<< mount =="
-        python -m pytest -s -v --doctest-modules --cov=datalad_helloworld --pyargs datalad_helloworld
+        python -m pytest -s -v --doctest-modules --cov=datalad_ria --pyargs datalad_ria
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,6 @@
 include CONTRIBUTORS LICENSE versioneer.py
 graft _datalad_buildsupport
-graft datalad_helloworld
+graft datalad_ria
 graft docs
 prune docs/build
 global-exclude *.py[cod]
diff --git a/README.md b/README.md
@@ -1,52 +1,36 @@
-# DataLad extension template
+# DataLad RIA tools
 
 [![Build status](https://ci.appveyor.com/api/projects/status/g9von5wtpoidcecy/branch/main?svg=true)](https://ci.appveyor.com/project/mih/datalad-extension-template/branch/main) [![codecov.io](https://codecov.io/github/datalad/datalad-extension-template/coverage.svg?branch=main)](https://codecov.io/github/datalad/datalad-extension-template?branch=main) [![crippled-filesystems](https://github.com/datalad/datalad-extension-template/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-extension-template/actions?query=workflow%3Acrippled-filesystems) [![docs](https://github.com/datalad/datalad-extension-template/workflows/docs/badge.svg)](https://github.com/datalad/datalad-extension-template/actions?query=workflow%3Adocs)
 
+This datalad extension will contain a modernized and improved implementation for RIA-related functionality.
+It is currently a work-in-progress.
 
-This repository contains an extension template that can serve as a starting point
-for implementing a [DataLad](http://datalad.org) extension. An extension can
-provide any number of additional DataLad commands that are automatically
-included in DataLad's command line and Python API.
+TODOs:
 
-For a demo, clone this repository and install the demo extension via
-
-    pip install -e .
-
-DataLad will now expose a new command suite with a `hello...` command.
-
-    % datalad --help |grep -B2 -A2 hello
-    *Demo DataLad command suite*
-
-      hello-cmd
-          Short description of the command
-
-To start implementing your own extension, [use this
-template](https://github.com/datalad/datalad-extension-template/generate), and
-adjust as necessary. A good approach is to
-
-- Pick a name for the new extension.
-- Look through the sources and replace `helloworld` with
+- [x] Pick a name for the new extension.
+- [x] Look through the sources and replace `helloworld` with
   `<newname>` (hint: `git grep helloworld` should find all
   spots).
-- Delete the example command implementation in `datalad_helloworld/hello_cmd.py`.
-- Implement a new command, and adjust the `command_suite` in
+- [ ] Delete the example command implementation in `datalad_helloworld/hello_cmd.py`.
+- [ ] Implement a new command, and adjust the `command_suite` in
   `datalad_helloworld/__init__.py` to point to it.
-- Replace `hello_cmd` with the name of the new command in
+- [ ] Replace `hello_cmd` with the name of the new command in
   `datalad_helloworld/tests/test_register.py` to automatically test whether the
   new extension installs correctly.
-- Adjust the documentation in `docs/source/index.rst`. Refer to [`docs/README.md`](docs/README.md) for more information on documentation building, testing and publishing.
-- Replace this README, and/or update the links in the badges at the top.
-- Update `setup.cfg` with appropriate metadata on the new extension.
-- Generate GitHub labels for use by the "Add changelog.d snippet" and
+- [ ] Adjust the documentation in `docs/source/index.rst`. Refer to [`docs/README.md`](docs/README.md) for more information on documentation building, testing and publishing.
+- [ ] Replace this README, and/or update the links in the badges at the top.
+- [x] Update `setup.cfg` with appropriate metadata on the new extension.
+- [ ] Generate GitHub labels for use by the "Add changelog.d snippet" and
   "Auto-release on PR merge" workflows by using the code in the
   `datalad/release-action` repository [as described in its
   README](https://github.com/datalad/release-action#command-labels).
 
-You can consider filling in the provided [.zenodo.json](.zenodo.json) file with
+- [ ] You can consider filling in the provided [.zenodo.json](.zenodo.json) file with
 contributor information and [meta data](https://developers.zenodo.org/#representation)
 to acknowledge contributors and describe the publication record that is created when
 [you make your code citeable](https://guides.github.com/activities/citable-code/)
-by archiving it using [zenodo.org](https://zenodo.org/). You may also want to
+by archiving it using [zenodo.org](https://zenodo.org/).
+- [ ] You may also want to
 consider acknowledging contributors with the
 [allcontributors bot](https://allcontributors.org/docs/en/bot/overview).
 

diff --git a/changelog.d/templates/new_fragment.md.j2 b/changelog.d/templates/new_fragment.md.j2
@@ -4,7 +4,7 @@
 ### {{ cat }}
 
 - Describe change, possibly reference closed/related issue/PR.
-  Fixes https://github.com/datalad/datalad-helloworld/issues/XXX via
-  https://github.com/datalad/datalad-helloworld/pull/XXX (by [@GITHUBHANDLE](https://github.com/GITHUBHANDLE))
+  Fixes https://github.com/datalad/datalad-ria/issues/XXX via
+  https://github.com/datalad/datalad-ria/pull/XXX (by [@GITHUBHANDLE](https://github.com/GITHUBHANDLE))
 -->
 {% endfor -%}
diff --git a/datalad_helloworld/__init__.py → datalad_ria/__init__.py b/datalad_helloworld/__init__.py → datalad_ria/__init__.py
@@ -3,19 +3,19 @@
 __docformat__ = 'restructuredtext'
 
 import logging
-lgr = logging.getLogger('datalad.helloworld')
+lgr = logging.getLogger('datalad.ria')
 
 # Defines a datalad command suite.
 # This variable must be bound as a setuptools entrypoint
 # to be found by datalad
 command_suite = (
     # description of the command suite, displayed in cmdline help
-    "Demo DataLad command suite",
+    "DataLad-ria command suite",
     [
         # specification of a command, any number of commands can be defined
         (
             # importable module that contains the command implementation
-            'datalad_helloworld.hello_cmd',
+            'datalad_ria.hello_cmd',
             # name of the command class implementation in above module
             'HelloWorld',
             # optional name of the command in the cmdline API

diff --git a/datalad_helloworld/_version.py → datalad_ria/_version.py b/datalad_helloworld/_version.py → datalad_ria/_version.py
@@ -45,7 +45,7 @@ def get_config():
     cfg.style = "pep440"
     cfg.tag_prefix = ""
     cfg.parentdir_prefix = ""
-    cfg.versionfile_source = "datalad_helloworld/_version.py"
+    cfg.versionfile_source = "datalad_ria/_version.py"
     cfg.verbose = False
     return cfg
 

diff --git a/datalad_helloworld/conftest.py → datalad_ria/conftest.py b/datalad_helloworld/conftest.py → datalad_ria/conftest.py
diff --git a/datalad_helloworld/hello_cmd.py → datalad_ria/hello_cmd.py b/datalad_helloworld/hello_cmd.py → datalad_ria/hello_cmd.py
@@ -15,7 +15,7 @@
 from datalad.interface.results import get_status_dict
 
 import logging
-lgr = logging.getLogger('datalad.helloworld.hello_cmd')
+lgr = logging.getLogger('datalad.ria.hello_cmd')
 
 
 # decoration auto-generates standard help

diff --git a/datalad_helloworld/tests/__init__.py → datalad_ria/tests/__init__.py b/datalad_helloworld/tests/__init__.py → datalad_ria/tests/__init__.py
diff --git a/datalad_helloworld/tests/test_register.py → datalad_ria/tests/test_register.py b/datalad_helloworld/tests/test_register.py → datalad_ria/tests/test_register.py
diff --git a/docs/Makefile b/docs/Makefile
@@ -87,9 +87,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/datalad_helloworld.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/datalad_ria.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad_helloworld.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad_ria.qhc"
 
 applehelp:
 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -104,8 +104,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/datalad_helloworld"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datalad_helloworld"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/datalad_ria"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datalad_ria"
 	@echo "# devhelp"
 
 epub:

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# datalad_helloworld documentation build configuration file, created by
+# datalad_ria documentation build configuration file, created by
 # sphinx-quickstart on Tue Oct 13 08:41:19 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -24,7 +24,7 @@
 )
 from os import pardir
 
-import datalad_helloworld
+import datalad_ria
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -40,7 +40,7 @@
         try:
             subprocess.run(
                 args=[setup_py_path, 'build_manpage',
-                     '--cmdsuite', 'datalad_helloworld:command_suite',
+                     '--cmdsuite', 'datalad_ria:command_suite',
                      '--manpath', abspath(opj(
                          dirname(setup_py_path), 'build', 'man')),
                      '--rstpath', opj(dirname(__file__), 'generated', 'man'),
@@ -95,7 +95,7 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-version = datalad_helloworld.__version__
+version = datalad_ria.__version__
 release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation

diff --git a/docs/source/design.rst b/docs/source/design.rst
@@ -0,0 +1,4 @@
+.. _design:
+
+RIA Design
+**********
diff --git a/docs/source/for_admins.rst b/docs/source/for_admins.rst
@@ -0,0 +1,5 @@
+.. _admindocs:
+
+For administrators and data managers
+************************************
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,13 +1,25 @@
-DataLad extension template
-**************************
+DataLad-ria extension
+*********************
 
-This is a template for creating a `DataLad <http://datalad.org>`__ extension
-that equips DataLad with additional functionality.
+This is a DataLad extension with modernized replacements for the RIA functionality
+in DataLad versions 0.13-0.19.X.
+It is currently under development.
 
 
 API
 ===
 
+DataLad-ria Guides
+------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   quickstart.rst
+   design.rst
+   usage_examples.rst
+   for_admins.rst
+
 High-level API commands
 -----------------------
 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -0,0 +1,4 @@
+.. _quickstart:
+
+Quickstart
+**********
diff --git a/docs/source/usage_examples.rst b/docs/source/usage_examples.rst
@@ -0,0 +1,4 @@
+.. _usage:
+
+DataLad-RIA usage examples
+**************************
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+
+formats: all
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - path: .
+      method: pip
+    - requirements: requirements-devel.txt
diff --git a/setup.cfg b/setup.cfg
@@ -2,7 +2,7 @@
 url = https://github.com/datalad/datalad-extension-template
 author = The DataLad Team and Contributors
 author_email = team@datalad.org
-description = demo DataLad extension package
+description = DataLad-ria extension
 long_description = file:README.md
 long_description_content_type = text/markdown; charset=UTF-8
 license = MIT
@@ -12,14 +12,14 @@ classifiers =
     Programming Language :: Python :: 3
 
 [options]
-python_requires = >= 3.7
+python_requires = >= 3.8
 install_requires =
-    datalad >= 0.18.0
+    datalad >= 0.19.0
 packages = find_namespace:
 include_package_data = True
 
 [options.packages.find]
-include = datalad_helloworld*
+include = datalad_ria*
 
 [options.extras_require]
 # this matches the name used by -core and what is expected by some CI setups
@@ -39,21 +39,21 @@ datalad.extensions =
     # the label in front of '=' is the command suite label
     # the entrypoint can point to any symbol of any name, as long it is
     # valid datalad interface specification (see demo in this extensions)
-    helloworld = datalad_helloworld:command_suite
+    ria = datalad_ria:command_suite
 
 [versioneer]
 # See the docstring in versioneer.py for instructions. Note that you must
 # re-run 'versioneer.py setup' after changing this section, and commit the
 # resulting files.
 VCS = git
 style = pep440
-versionfile_source = datalad_helloworld/_version.py
-versionfile_build = datalad_helloworld/_version.py
+versionfile_source = datalad_ria/_version.py
+versionfile_build = datalad_ria/_version.py
 tag_prefix =
 parentdir_prefix =
 
 [coverage:report]
 show_missing = True
 omit =
     # versioneer code
-    datalad_helloworld/_version.py
+    datalad_ria/_version.py
diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@
 cmdclass.update(build_manpage=BuildManPage)
 
 if __name__ == '__main__':
-    setup(name='datalad_helloworld',
+    setup(name='datalad_ria',
           version=versioneer.get_version(),
           cmdclass=cmdclass,
     )