inspec

Name	inspec JSON
Version	0.5 JSON
	download
home_page
Summary	Inspect audio and image files from command line
upload_time	2023-07-23 19:22:50
maintainer
docs_url	None
author
requires_python	>=3.10
license	MIT License Copyright (c) 2021 kevinyu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	spectrogram audio visualization sound terminal
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # inspec

Visually inspect audio files and images from the command line by displaying them as unicode characters.

Tested on `png`, `jpg`, `mp4`, and `wav` files.

## Quick start

```
pip install inspec
```

From command line

```
Usage: inspec [OPTIONS] COMMAND [ARGS]...

Commands:
  imshow  Print an image to stdout
  listen  Listen to audio and print to stdout
  open    Open interactive GUI
  show    Print an audio file to stdout
```

From python

```python
import inspec

inspec.imshow("path/to/image/file.png")
inspec.ashow("path/to/audio/file.wav")
inspec.vshow("path/to/video/file.mp4")
inspec.listen()
```

## Dev setup

```
git clone git@github.com:kevinyu/inspec.git
cd inspec
python -m venv env
source bin/activate
pip install -e .
```

You might need `ffmpeg` for video support not sure tho.

Run tests

```
pytest src
```

# Examples

```shell
inspec show demo/warbling.wav
inspec imshow demo/mandrill.jpg
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "inspec",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "spectrogram,audio,visualization,sound,terminal",
    "author": "",
    "author_email": "Kevin Yu <thekevinyu@gmail.edu>",
    "download_url": "https://files.pythonhosted.org/packages/8f/d3/56aadd2dab81d7900c3d8d0ee963099aa84da4ee327c5f21e72d49c7bd9d/inspec-0.5.tar.gz",
    "platform": null,
    "description": "# inspec\n\nVisually inspect audio files and images from the command line by displaying them as unicode characters.\n\nTested on `png`, `jpg`, `mp4`, and `wav` files.\n\n## Quick start\n\n```\npip install inspec\n```\n\nFrom command line\n\n```\nUsage: inspec [OPTIONS] COMMAND [ARGS]...\n\nCommands:\n  imshow  Print an image to stdout\n  listen  Listen to audio and print to stdout\n  open    Open interactive GUI\n  show    Print an audio file to stdout\n```\n\nFrom python\n\n```python\nimport inspec\n\ninspec.imshow(\"path/to/image/file.png\")\ninspec.ashow(\"path/to/audio/file.wav\")\ninspec.vshow(\"path/to/video/file.mp4\")\ninspec.listen()\n```\n\n## Dev setup\n\n```\ngit clone git@github.com:kevinyu/inspec.git\ncd inspec\npython -m venv env\nsource bin/activate\npip install -e .\n```\n\nYou might need `ffmpeg` for video support not sure tho.\n\nRun tests\n\n```\npytest src\n```\n\n# Examples\n\n```shell\ninspec show demo/warbling.wav\ninspec imshow demo/mandrill.jpg\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2021 kevinyu  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Inspect audio and image files from command line",
    "version": "0.5",
    "project_urls": {
        "Repository": "https://github.com/kevinyu/inspec"
    },
    "split_keywords": [
        "spectrogram",
        "audio",
        "visualization",
        "sound",
        "terminal"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a5daee5528d08616b85676661c8c875e55e4a0d30485359d6f7810c02d7345b2",
                "md5": "e35a47a996adfb48475e5de5e2be6530",
                "sha256": "8e03276219fa2101e632b8f891c896262e527dd5a16cb7bd83411abd2f8ba37e"
            },
            "downloads": -1,
            "filename": "inspec-0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e35a47a996adfb48475e5de5e2be6530",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 44571,
            "upload_time": "2023-07-23T19:22:48",
            "upload_time_iso_8601": "2023-07-23T19:22:48.803130Z",
            "url": "https://files.pythonhosted.org/packages/a5/da/ee5528d08616b85676661c8c875e55e4a0d30485359d6f7810c02d7345b2/inspec-0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8fd356aadd2dab81d7900c3d8d0ee963099aa84da4ee327c5f21e72d49c7bd9d",
                "md5": "c5c1ed21bbf0a800b05b3d1294141556",
                "sha256": "805f0dc8891fb06683c4267ff47ada27b3c0f15b43b05736f2c02da6fff0af10"
            },
            "downloads": -1,
            "filename": "inspec-0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "c5c1ed21bbf0a800b05b3d1294141556",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 33250,
            "upload_time": "2023-07-23T19:22:50",
            "upload_time_iso_8601": "2023-07-23T19:22:50.706169Z",
            "url": "https://files.pythonhosted.org/packages/8f/d3/56aadd2dab81d7900c3d8d0ee963099aa84da4ee327c5f21e72d49c7bd9d/inspec-0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-23 19:22:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kevinyu",
    "github_project": "inspec",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "inspec"
}