| Name | nwbinspector JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | Tool to inspect NWB files for best practices compliance. |
| upload_time | 2024-12-05 23:16:14 |
| maintainer | None |
| docs_url | None |
| author | Cody Baker, Steph Prince, Szonja Weigl, Heberto Mayorquin, Paul Adkisson, Luiz Tauffer |
| requires_python | >=3.9 |
| license | “nwbinspector” Copyright (c) 2022-2024, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form. |
| keywords |
nwb
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://raw.githubusercontent.com/neurodatawithoutborders/nwbinspector/dev/docs/logo/logo.png" width="250" alt="NWB Inspector logo"/>
<p align="center">
<a href="https://pypi.org/project/dandi_s3_log_parser/"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/nwbinspector.svg"></a>
<a href="https://codecov.io/github/CatalystNeuro/dandi_s3_log_parser?branch=main"><img alt="codecov" src="https://codecov.io/github/NeurodataWithoutBorders/nwbinspector/coverage.svg?branch=main"></a>
</p>
<p align="center">
<a href="https://pypi.org/project/nwbinpsector/"><img alt="PyPI latest release version" src="https://badge.fury.io/py/nwbinspector.svg?id=py&kill_cache=1"></a>
<a href="https://github.com/NeurodataWithoutBorders/nwbinspector/blob/dev/license.txt"><img alt="License: BSD-3" src="https://img.shields.io/pypi/l/nwbinspector.svg"></a>
</p>
<p align="center">
<a href="https://github.com/psf/black"><img alt="Python code style: Black" src="https://img.shields.io/badge/python_code_style-black-000000.svg"></a>
<a href="https://github.com/astral-sh/ruff"><img alt="Python code style: Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
</p>
<p align="center">
<a href="https://nwbinspector.readthedocs.io/"><img alt="Documentation build status" src="https://readthedocs.org/projects/nwbinspector/badge/?version=dev"></a>
<a href="https://github.com/NeurodataWithoutBorders/nwbinspector/actions/workflows/dailies.yml/badge.svg"><img alt="Daily tests" src="https://github.com/NeurodataWithoutBorders/nwbinspector/actions/workflows/dailies.yml/badge.svg"></a>
</p>
</p>
Inspect NWB files for compliance with [NWB Best Practices](https://nwbinspector.readthedocs.io/en/dev/best_practices/best_practices_index.html).
This inspector is meant as a companion to the PyNWB validator, which checks for strict schema compliance. This tool attempts to apply some common sense to find components of the file that are technically compliant, but possibly incorrect, suboptimal in their representation, or deviate from best practices.
This tool is meant simply as a data review aid. It does not catch all possible violations of best practices and any warnings it does produce should be checked by a knowledgeable reviewer.
## Installation
```bash
pip install nwbinspector
```
## Usage
```bash
# supply a path to an NWB file
nwbinspector path/to/my/data.nwb
# supply a path to a directory containing NWB files
nwbinspector path/to/my/data/folder/
```
Read about more detailed usage in the main [documentation](https://nwbinspector.readthedocs.io/en/dev/user_guide/user_guide_index.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "nwbinspector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "nwb",
"author": "Cody Baker, Steph Prince, Szonja Weigl, Heberto Mayorquin, Paul Adkisson, Luiz Tauffer",
"author_email": "Ben Dichter <ben.dichter@catalystneuro.com>",
"download_url": "https://files.pythonhosted.org/packages/5e/eb/20d1dd54349729e8b0254c04d5a0f1955545345a68ce724e12418c170c6c/nwbinspector-0.6.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neurodatawithoutborders/nwbinspector/dev/docs/logo/logo.png\" width=\"250\" alt=\"NWB Inspector logo\"/>\n\n <p align=\"center\">\n <a href=\"https://pypi.org/project/dandi_s3_log_parser/\"><img alt=\"Supported Python versions\" src=\"https://img.shields.io/pypi/pyversions/nwbinspector.svg\"></a>\n <a href=\"https://codecov.io/github/CatalystNeuro/dandi_s3_log_parser?branch=main\"><img alt=\"codecov\" src=\"https://codecov.io/github/NeurodataWithoutBorders/nwbinspector/coverage.svg?branch=main\"></a>\n </p>\n <p align=\"center\">\n <a href=\"https://pypi.org/project/nwbinpsector/\"><img alt=\"PyPI latest release version\" src=\"https://badge.fury.io/py/nwbinspector.svg?id=py&kill_cache=1\"></a>\n <a href=\"https://github.com/NeurodataWithoutBorders/nwbinspector/blob/dev/license.txt\"><img alt=\"License: BSD-3\" src=\"https://img.shields.io/pypi/l/nwbinspector.svg\"></a>\n </p>\n <p align=\"center\">\n <a href=\"https://github.com/psf/black\"><img alt=\"Python code style: Black\" src=\"https://img.shields.io/badge/python_code_style-black-000000.svg\"></a>\n <a href=\"https://github.com/astral-sh/ruff\"><img alt=\"Python code style: Ruff\" src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\"></a>\n </p>\n <p align=\"center\">\n <a href=\"https://nwbinspector.readthedocs.io/\"><img alt=\"Documentation build status\" src=\"https://readthedocs.org/projects/nwbinspector/badge/?version=dev\"></a>\n <a href=\"https://github.com/NeurodataWithoutBorders/nwbinspector/actions/workflows/dailies.yml/badge.svg\"><img alt=\"Daily tests\" src=\"https://github.com/NeurodataWithoutBorders/nwbinspector/actions/workflows/dailies.yml/badge.svg\"></a>\n </p>\n</p>\n\nInspect NWB files for compliance with [NWB Best Practices](https://nwbinspector.readthedocs.io/en/dev/best_practices/best_practices_index.html).\n\nThis inspector is meant as a companion to the PyNWB validator, which checks for strict schema compliance. This tool attempts to apply some common sense to find components of the file that are technically compliant, but possibly incorrect, suboptimal in their representation, or deviate from best practices.\n\nThis tool is meant simply as a data review aid. It does not catch all possible violations of best practices and any warnings it does produce should be checked by a knowledgeable reviewer.\n\n\n\n## Installation\n\n```bash\npip install nwbinspector\n```\n\n\n\n## Usage\n\n```bash\n# supply a path to an NWB file\nnwbinspector path/to/my/data.nwb\n\n# supply a path to a directory containing NWB files\nnwbinspector path/to/my/data/folder/\n```\n\nRead about more detailed usage in the main [documentation](https://nwbinspector.readthedocs.io/en/dev/user_guide/user_guide_index.html).\n",
"bugtrack_url": null,
"license": "\u201cnwbinspector\u201d Copyright (c) 2022-2024, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code (\"Enhancements\") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.",
"summary": "Tool to inspect NWB files for best practices compliance.",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://github.com/NeurodataWithoutBorders/nwbinspector"
},
"split_keywords": [
"nwb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e849dfaf048d626d970f305855959f93614733001294d99f368d08c173bcbb3",
"md5": "8955bd12057cc4e1d88324bfc2f93b07",
"sha256": "62655a73307fc769dfb2c6af0532e413e99b1814515c645a1e0981c236bb2b93"
},
"downloads": -1,
"filename": "nwbinspector-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8955bd12057cc4e1d88324bfc2f93b07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 63345,
"upload_time": "2024-12-05T23:16:12",
"upload_time_iso_8601": "2024-12-05T23:16:12.497266Z",
"url": "https://files.pythonhosted.org/packages/8e/84/9dfaf048d626d970f305855959f93614733001294d99f368d08c173bcbb3/nwbinspector-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5eeb20d1dd54349729e8b0254c04d5a0f1955545345a68ce724e12418c170c6c",
"md5": "8b09ee83f0681b7e8427555f309f104d",
"sha256": "725a8038da4aa954fe6be0cd2c77a40880f0eb0bd18a7593d0c772c21ca163c2"
},
"downloads": -1,
"filename": "nwbinspector-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "8b09ee83f0681b7e8427555f309f104d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 594330,
"upload_time": "2024-12-05T23:16:14",
"upload_time_iso_8601": "2024-12-05T23:16:14.573074Z",
"url": "https://files.pythonhosted.org/packages/5e/eb/20d1dd54349729e8b0254c04d5a0f1955545345a68ce724e12418c170c6c/nwbinspector-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 23:16:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeurodataWithoutBorders",
"github_project": "nwbinspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nwbinspector"
}
