picopins


Namepicopins JSON
Version 1.2.0 PyPI version JSON
download
home_page
SummaryA command-line pinout for the Raspberry Pi Pico W
upload_time2023-07-27 20:04:14
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT License Copyright (c) 2023 Gadgetoid (Phil Howard). 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 pico raspberry
VCS
bugtrack_url
requirements rich
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Raspberry Pi Pico GPIO Pinout

A beautiful GPIO pinout and pin function guide for the Raspberry Pi Pico.

![Example image](https://raw.githubusercontent.com/pinout-xyz/picopins/main/example.png)

[![Build Status](https://img.shields.io/github/actions/workflow/status/pinout-xyz/picopins/build.yml?branch=main)](https://github.com/pinout-xyz/picopins/actions/workflows/build.yml)
[![PyPi Package](https://img.shields.io/pypi/v/picopins.svg)](https://pypi.python.org/pypi/picopins)
[![Python Versions](https://img.shields.io/pypi/pyversions/picopins.svg)](https://pypi.python.org/pypi/picopins)

# Usage

```
usage: picopins [--pins] [--all] or {spi,i2c,uart,pwm}
       --pins - show physical pin numbers
       --all or {spi,i2c,uart,pwm} - pick list of interfaces to show
       --hide-gpio - hide GPIO pins
       --find "<text>" - highlight pins matching <text>

eg:    picopins i2c  - show GPIO and I2C labels
       picopins      - basic GPIO pinout
```

# Installing

* Just run `python3 -m pip install picopins`

# Acknowledgements

This project was inspired by GPIO Zero's command-line pinout - https://github.com/gpiozero/gpiozero

It somehow wasn't inspired by Raspberry Pi Spy's "picopins" which came first and solves this same problem in bash - https://www.raspberrypi-spy.co.uk/2022/12/pi-pico-pinout-display-on-the-command-line/

Like RPi Spy's picopins it started as a GitHub gist, you can find the history here - https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118/revisions

# Changelog

1.2.0
-----

* Highlight LED if `--find GP25` or `--find LED`
* Refactor options and add a `--version` command

1.1.0
-----

* Highlight GPIO label if `--find` matches a hidden label
* Add regex support to `--find`
* Rewrite render flow to make it less hacky
* Light mode is back! `--light`
* Move error text above usage message

1.0.1
-----

* Tidy up readme

1.0.0
-----

* Initial Release
* Ported from https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "picopins",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "Philip Howard <pinout@gadgetoid.com>",
    "keywords": "Pico,Raspberry",
    "author": "",
    "author_email": "Philip Howard <pinout@gadgetoid.com>",
    "download_url": "https://files.pythonhosted.org/packages/e5/cf/f3915f0d9155af72428f2357c0ebd0542ae7a581478afce6260e2cfb53ff/picopins-1.2.0.tar.gz",
    "platform": null,
    "description": "# Raspberry Pi Pico GPIO Pinout\n\nA beautiful GPIO pinout and pin function guide for the Raspberry Pi Pico.\n\n![Example image](https://raw.githubusercontent.com/pinout-xyz/picopins/main/example.png)\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/pinout-xyz/picopins/build.yml?branch=main)](https://github.com/pinout-xyz/picopins/actions/workflows/build.yml)\n[![PyPi Package](https://img.shields.io/pypi/v/picopins.svg)](https://pypi.python.org/pypi/picopins)\n[![Python Versions](https://img.shields.io/pypi/pyversions/picopins.svg)](https://pypi.python.org/pypi/picopins)\n\n# Usage\n\n```\nusage: picopins [--pins] [--all] or {spi,i2c,uart,pwm}\n       --pins - show physical pin numbers\n       --all or {spi,i2c,uart,pwm} - pick list of interfaces to show\n       --hide-gpio - hide GPIO pins\n       --find \"<text>\" - highlight pins matching <text>\n\neg:    picopins i2c  - show GPIO and I2C labels\n       picopins      - basic GPIO pinout\n```\n\n# Installing\n\n* Just run `python3 -m pip install picopins`\n\n# Acknowledgements\n\nThis project was inspired by GPIO Zero's command-line pinout - https://github.com/gpiozero/gpiozero\n\nIt somehow wasn't inspired by Raspberry Pi Spy's \"picopins\" which came first and solves this same problem in bash - https://www.raspberrypi-spy.co.uk/2022/12/pi-pico-pinout-display-on-the-command-line/\n\nLike RPi Spy's picopins it started as a GitHub gist, you can find the history here - https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118/revisions\n\n# Changelog\n\n1.2.0\n-----\n\n* Highlight LED if `--find GP25` or `--find LED`\n* Refactor options and add a `--version` command\n\n1.1.0\n-----\n\n* Highlight GPIO label if `--find` matches a hidden label\n* Add regex support to `--find`\n* Rewrite render flow to make it less hacky\n* Light mode is back! `--light`\n* Move error text above usage message\n\n1.0.1\n-----\n\n* Tidy up readme\n\n1.0.0\n-----\n\n* Initial Release\n* Ported from https://gist.github.com/Gadgetoid/192af85a3eb05d4a6ac1db076c4ef118\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Gadgetoid (Phil Howard).  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": "A command-line pinout for the Raspberry Pi Pico W",
    "version": "1.2.0",
    "project_urls": {
        "GitHub": "https://www.github.com/pinout-xyz/picopins",
        "Homepage": "https://pico.pinout.xyz"
    },
    "split_keywords": [
        "pico",
        "raspberry"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d999d61057eda215b5f7ae13f308a2b13a2081952da9dd92e41a37b428eea619",
                "md5": "121bed11788ab21a3fc94141ce99f204",
                "sha256": "85261f2383503897be75bb23fb3907190c94a1d414d9666f96ed47987bbae5fb"
            },
            "downloads": -1,
            "filename": "picopins-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "121bed11788ab21a3fc94141ce99f204",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 9394,
            "upload_time": "2023-07-27T20:04:13",
            "upload_time_iso_8601": "2023-07-27T20:04:13.165096Z",
            "url": "https://files.pythonhosted.org/packages/d9/99/d61057eda215b5f7ae13f308a2b13a2081952da9dd92e41a37b428eea619/picopins-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e5cff3915f0d9155af72428f2357c0ebd0542ae7a581478afce6260e2cfb53ff",
                "md5": "b416de37a8eac50593bd724b50efcbc8",
                "sha256": "6f9e7bed0843b6d58dcb14126f27559552a45c12304bb830be1c8954a19f4ade"
            },
            "downloads": -1,
            "filename": "picopins-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b416de37a8eac50593bd724b50efcbc8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 42582,
            "upload_time": "2023-07-27T20:04:14",
            "upload_time_iso_8601": "2023-07-27T20:04:14.758939Z",
            "url": "https://files.pythonhosted.org/packages/e5/cf/f3915f0d9155af72428f2357c0ebd0542ae7a581478afce6260e2cfb53ff/picopins-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-27 20:04:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pinout-xyz",
    "github_project": "picopins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "rich",
            "specs": [
                [
                    ">=",
                    "13.3.5"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "picopins"
}
        
Elapsed time: 1.90934s