moved fileformats sub-packages inside common subfolder

Author: tclose

fileformats-extras/conftest.py

@@ -0,0 +1,13 @@
+   Copyright 2021 Nipype developers
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fileformats/extras/LICENSE

@@ -0,0 +1,29 @@
+FileFormats-CHANGEME Extras
+======================================
+.. image:: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml/badge.svg
+    :target: https://github.com/nipype/pydra-freesurfer/actions/workflows/ci-cd.yaml
+
+
+This is a extras module for the `fileformats-CHANGEME <https://github.com/nipype/pydra-freesurfer/>`__
+fileformats extension package, which provides additional functionality to format classes (i.e. aside
+from basic identification and validation), such as conversion tools, metadata parsers, test data generators, etc...
+
+
+Quick Installation
+------------------
+
+This extension can be installed for Python 3 using *pip*::
+
+    $ pip3 install fileformats-CHANGEME-extras
+
+This will install the core package and any other dependencies
+
+License
+-------
+
+This work is licensed under a
+`Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_
+
+.. image:: https://i.creativecommons.org/l/by/4.0/88x31.png
+  :target: http://creativecommons.org/licenses/by/4.0/
+  :alt: Creative Commons Attribution 4.0 International License

fileformats/extras/README.rst

@@ -5,14 +5,14 @@ build-backend = "hatchling.build"
 [project]
 name = "fileformats-medimage-CHANGEME-extras"
 description = "Extensions to add functionality to tool-specific *fileformats* classes"
-readme = "../README.rst"
+readme = "README.rst"
 requires-python = ">=3.8"
 dependencies = [
     "fileformats >= 0.7",
     "fileformats-medimage-CHANGEME",
     "pydra >= 0.22.0"
 ]
-license = {file = "../LICENSE"}
+license = {file = "LICENSE"}
 authors = [
     {name = "Thomas G. Close", email = "[email protected]"},
 ]
@@ -62,7 +62,7 @@ repository = "https://github.com/nipype/pydra-CHANGEME"
 
 [tool.hatch.version]
 source = "vcs"
-raw-options = { root = ".." }
+raw-options = { root = "../.." }
 
 [tool.hatch.build.hooks.vcs]
 version-file = "fileformats/extras/medimage_CHANGEME/_version.py"

fileformats-extras/fileformats/extras/medimage_CHANGEME/__init__.py renamed to fileformats/extras/fileformats/extras/medimage_CHANGEME/__init__.py

@@ -0,0 +1,13 @@
+   Copyright 2021 Nipype developers
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fileformats-extras/pyproject.toml renamed to fileformats/extras/pyproject.toml

@@ -0,0 +1,39 @@
+How to customise this template
+==============================
+
+#. Rename the `fileformats/src/CHANGEME` directory to the name of the fileformats subpackage (e.g. `medimage_fsl`)
+#. Search and replace "CHANGEME" with the name of the fileformats subpackage the extras are to be added
+#. Replace name + email placeholders in `pyproject.toml` for developers and maintainers
+#. Add the extension file-format classes
+#. Ensure that all the extension file-format classes are imported into the extras package root, i.e. `fileformats/CHANGEME`
+#. Delete these instructions
+
+...
+
+FileFormats Extension - CHANGEME
+====================================
+.. image:: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml/badge.svg
+    :target: https://github.com/nipype/pydra-CHANGEME/actions/workflows/ci-cd.yml
+
+This is the "CHANGEME" extension module for the
+`fileformats <https://github.com/ArcanaFramework/fileformats-core>`__ package
+
+
+Quick Installation
+------------------
+
+This extension can be installed for Python 3 using *pip*::
+
+    $ pip3 install fileformats-CHANGEME
+
+This will install the core package and any other dependencies
+
+License
+-------
+
+This work is licensed under a
+`Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_
+
+.. image:: https://i.creativecommons.org/l/by/4.0/88x31.png
+  :target: http://creativecommons.org/licenses/by/4.0/
+  :alt: Creative Commons Attribution 4.0 International License

fileformats/src/LICENSE

@@ -5,13 +5,13 @@ build-backend = "hatchling.build"
 [project]
 name = "fileformats-medimage-CHANGEME"
 description = "Classes for representing different file formats in Python classes for use in type hinting in data workflows"
-readme = "../README.rst"
+readme = "README.rst"
 requires-python = ">=3.8"
 dependencies = [
     "fileformats >= 0.4",
     "fileformats-medimage > = 0.2"
 ]
-license = {file = "../LICENSE"}
+license = {file = "LICENSE"}
 authors = [
     {name = "Thomas G. Close", email = "[email protected]"},
 ]
@@ -59,7 +59,7 @@ repository = "https://github.com/nipype/pydra-CHANGEME"
 
 [tool.hatch.version]
 source = "vcs"
-raw-options = { root = ".." }
+raw-options = { root = "../.." }
 
 [tool.hatch.build.hooks.vcs]
 version-file = "fileformats/medimage_CHANGEME/_version.py"