Merge pull request #80 from Remi-Gau/clean_up

[MAINT] post release clean up

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "autoDocstring.docstringFormat": "numpy"
+  "autoDocstring.docstringFormat": "numpy",
+  "esbonio.sphinx.confDir": ""
 }

CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+-->
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+
+## [0.1.0]
+
+* Add infrastructure files and bids.reports module by @tsalo in https://github.com/bids-standard/pybids-reports/pull/1
+* Fix testing suite by @tsalo in https://github.com/bids-standard/pybids-reports/pull/4
+* [DOC] update readme by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/15
+* [ENH] use mustache template by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/18
+* [MAINT] update packaging by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/27
+* [DOC] add basic doc setup by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/19
+* [MAINT] add  type  information by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/30
+* [ENH] add CLI by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/32
+* [MAINT] remove manifest by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/45
+* [STY] use isort instead of sort python import by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/66
+* [MAINT] Update mustache templates by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/67
+* [ENH] use bids metadata directly and adapt to new templates by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/68
+* [ENH] add support for perf, meeg, pet templates by @Remi-Gau in https://github.com/bids-standard/pybids-reports/pull/72

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Brain Imaging Data Structure
+Copyright (c) Brain Imaging Data Structure
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,25 +2,33 @@
 [![Documentation Status](https://readthedocs.org/projects/pybids-reports/badge/?version=latest)](https://pybids-reports.readthedocs.io/en/latest/?badge=latest)
 ![https://github.com/psf/black](https://img.shields.io/badge/code%20style-black-000000.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/bids-standard/pybids-reports/main.svg)](https://results.pre-commit.ci/latest/github/bids-standard/pybids-reports/main)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nilearn.svg)](https://pypi.org/project/nilearn/)
+
 
 # pybids-reports
 
-pybids-reports is a subpackage of pyBIDS, implementing automatic report
-generation from BIDS datasets.
+pybids-reports is a subpackage of pyBIDS,
+implementing automatic report generation from BIDS datasets.
 
 See the [BIDS paper](http://www.nature.com/articles/sdata201644) and
 http://bids.neuroimaging.io website for more information.
 
 NOTE: The reports module is experimental and currently under active development,
-and as such should be used with caution. Please remember to verify any generated
-report before putting it to use.
+and as such should be used with caution.
+Please remember to verify any generated report before putting it to use.
+
+Additionally, support for some dataypes (for example EEG or motion) may be limited or missing.
+
+## Install
 
-Additionally, only MRI datatypes (func, anat, fmap, and dwi) are currently
-supported.
+```bash
+pip install pybids-reports
+```
 
 ### Quickstart
 
-A simple example of standard usage follows. We assume that we have a root folder
+A simple example of standard usage follows.
+We assume that we have a root folder
 containing a BIDS-compliant project in `/bidsproject`.
 
 <!-- TODO
@@ -49,10 +57,9 @@ pub_description = descriptions.most_common()[0][0]
 
 ## License
 
-`pybids-reports` is licensed under the terms of the MIT license. See the file
-"LICENSE" for information on the history of this software, terms & conditions
-for usage, and a DISCLAIMER OF ALL WARRANTIES.
+`pybids-reports` is licensed under the terms of the MIT license.
 
-All trademarks referenced herein are property of their respective holders.
+See the file "LICENSE" for information on the history of this software,
+terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.
 
-Copyright (c) 2016--, PyBIDS developers, Planet Earth
+All trademarks referenced herein are property of their respective holders.

pyproject.toml

@@ -8,8 +8,6 @@ source = "vcs"
 [tool.hatch.build.targets.wheel]
 packages = ["bids"]
 only-include = ["bids/ext/reports"]
-# recursive-include bids/ext/reports/config *.json
-# recursive-include bids/ext/reports/tests/data *
 
 [tool.hatch.build.hooks.vcs]
 version-file = "bids/ext/reports/_version.py"