Browse Source

Customize as 'datalad-gooey' extension

Michael Hanke 1 year ago
parent
commit
5765452a98

+ 5 - 5
.appveyor.yml

@@ -62,7 +62,7 @@ environment:
 
     # Ubuntu core tests
     - ID: Ubu20
-      DTS: datalad_helloworld
+      DTS: datalad_gooey
       APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu2004
       INSTALL_SYSPKGS: python3-virtualenv
       # system git-annex is way too old, use better one
@@ -71,14 +71,14 @@ environment:
     # Windows core tests
     - ID: WinP39core
       # ~35 min
-      DTS: datalad_helloworld
+      DTS: datalad_gooey
       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_gooey
       APPVEYOR_BUILD_WORKER_IMAGE: macOS
       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_gooey --pyargs %DTS%
+  - sh:  python -m pytest -s -v -m "not (turtle)" --doctest-modules --cov=datalad_gooey --pyargs ${DTS}
 
 
 after_test:

+ 1 - 1
.gitattributes

@@ -1 +1 @@
-datalad_helloworld/_version.py export-subst
+datalad_gooey/_version.py export-subst

+ 1 - 1
.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_gooey --pyargs datalad_gooey

+ 1 - 1
MANIFEST.in

@@ -1,6 +1,6 @@
 include CONTRIBUTORS LICENSE versioneer.py
 graft _datalad_buildsupport
-graft datalad_helloworld
+graft datalad_gooey
 graft docs
 prune docs/build
 global-exclude *.py[cod]

+ 1 - 1
README.md

@@ -1,6 +1,6 @@
 # DataLad extension template
 
-[![Build status](https://ci.appveyor.com/api/projects/status/g9von5wtpoidcecy/branch/master?svg=true)](https://ci.appveyor.com/project/mih/datalad-extension-template/branch/master) [![codecov.io](https://codecov.io/github/datalad/datalad-extension-template/coverage.svg?branch=master)](https://codecov.io/github/datalad/datalad-extension-template?branch=master) [![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)
+[![Build status](https://ci.appveyor.com/api/projects/status/g9von5wtpoidcecy/branch/main?svg=true)](https://ci.appveyor.com/project/mih/datalad-gooey/branch/main) [![codecov.io](https://codecov.io/github/datalad/datalad-gooey/coverage.svg?branch=main)](https://codecov.io/github/datalad/datalad-gooey?branch=main) [![crippled-filesystems](https://github.com/datalad/datalad-gooey/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-gooey/actions?query=workflow%3Acrippled-filesystems) [![docs](https://github.com/datalad/datalad-gooey/workflows/docs/badge.svg)](https://github.com/datalad/datalad-gooey/actions?query=workflow%3Adocs)
 
 
 This repository contains an extension template that can serve as a starting point

+ 2 - 2
datalad_helloworld/__init__.py

@@ -3,7 +3,7 @@
 __docformat__ = 'restructuredtext'
 
 import logging
-lgr = logging.getLogger('datalad.helloworld')
+lgr = logging.getLogger('datalad.ext.gooey')
 
 # Defines a datalad command suite.
 # This variable must be bound as a setuptools entrypoint
@@ -15,7 +15,7 @@ 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_gooey.hello_cmd',
             # name of the command class implementation in above module
             'HelloWorld',
             # optional name of the command in the cmdline API

+ 1 - 1
datalad_helloworld/_version.py

@@ -43,7 +43,7 @@ def get_config():
     cfg.style = "pep440"
     cfg.tag_prefix = ""
     cfg.parentdir_prefix = ""
-    cfg.versionfile_source = "datalad_helloworld/_version.py"
+    cfg.versionfile_source = "datalad_gooey/_version.py"
     cfg.verbose = False
     return cfg
 

+ 1 - 1
datalad_helloworld/hello_cmd.py

@@ -15,7 +15,7 @@ from datalad.support.constraints import EnsureChoice
 from datalad.interface.results import get_status_dict
 
 import logging
-lgr = logging.getLogger('datalad.helloworld.hello_cmd')
+lgr = logging.getLogger('datalad.ext.gooey.hello_cmd')
 
 
 # decoration auto-generates standard help

+ 4 - 4
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_gooey.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad_helloworld.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/datalad_gooey.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_gooey"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/datalad_gooey"
 	@echo "# devhelp"
 
 epub:

+ 1 - 1
docs/README.md

@@ -1,7 +1,7 @@
 ## Editing, building, and publishing extension documentation
 
 
-The `datalad-extension-template` uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html#) for document generation
+`datalad-gooey` uses [Sphinx](https://www.sphinx-doc.org/en/master/index.html#) for document generation
 and suggests using [Read the Docs](https://docs.readthedocs.io/en/stable/) for automatic documentation building, versioning, and hosting.
 
 Once you are ready to document your extension software, take note of the following:

+ 4 - 4
docs/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# datalad_helloworld documentation build configuration file, created by
+# datalad_gooey 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.path import (
 )
 from os import pardir
 
-import datalad_helloworld
+import datalad_gooey
 
 # 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 @@ for setup_py_path in (opj(pardir, 'setup.py'),  # travis
         try:
             subprocess.run(
                 args=[setup_py_path, 'build_manpage',
-                     '--cmdsuite', 'datalad_helloworld:command_suite',
+                     '--cmdsuite', 'datalad_gooey:command_suite',
                      '--manpath', abspath(opj(
                          dirname(setup_py_path), 'build', 'man')),
                      '--rstpath', opj(dirname(__file__), 'generated', 'man'),
@@ -95,7 +95,7 @@ author = u'DataLad team'
 # 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_gooey.__version__
 release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation

+ 7 - 7
setup.cfg

@@ -1,8 +1,8 @@
 [metadata]
-url = https://github.com/datalad/datalad-extension-template
+url = https://github.com/datalad/datalad-gooey
 author = The DataLad Team and Contributors
 author_email = team@datalad.org
-description = demo DataLad extension package
+description = A simple GUI for DataLad
 long_description = file:README.md
 long_description_content_type = text/markdown; charset=UTF-8
 license = MIT
@@ -19,7 +19,7 @@ packages = find_namespace:
 include_package_data = True
 
 [options.packages.find]
-include = datalad_helloworld*
+include = datalad_gooey*
 
 [options.extras_require]
 # this matches the name used by -core and what is expected by some CI setups
@@ -33,7 +33,7 @@ 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
+    gooey = datalad_gooey:command_suite
 
 [versioneer]
 # See the docstring in versioneer.py for instructions. Note that you must
@@ -41,8 +41,8 @@ datalad.extensions =
 # resulting files.
 VCS = git
 style = pep440
-versionfile_source = datalad_helloworld/_version.py
-versionfile_build = datalad_helloworld/_version.py
+versionfile_source = datalad_gooey/_version.py
+versionfile_build = datalad_gooey/_version.py
 tag_prefix =
 parentdir_prefix =
 
@@ -50,4 +50,4 @@ parentdir_prefix =
 show_missing = True
 omit =
     # versioneer code
-    datalad_helloworld/_version.py
+    datalad_gooey/_version.py

+ 1 - 1
setup.py

@@ -12,7 +12,7 @@ cmdclass = versioneer.get_cmdclass()
 cmdclass.update(build_manpage=BuildManPage)
 
 if __name__ == '__main__':
-    setup(name='datalad_helloworld',
+    setup(name='datalad_gooey',
           version=versioneer.get_version(),
           cmdclass=cmdclass,
     )