BB-PyCodeView


NameBB-PyCodeView JSON
Version 0.1.3 PyPI version JSON
download
home_page
SummaryView highlighted python code
upload_time2024-02-19 08:12:02
maintainer
docs_urlNone
authorErik Beebe
requires_python>=3.11,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # BB-PyCodeView

> View syntax highlighted code from a filename or module name

### Options

```console
$ code-view --help

    code-view - view highlighted python code

    ( -c |    --comments     ):  Show comments in output
                                  - default = False
    ( -f |    --function     ):  Function name - same as adding ':function' after module name
    ( -H |      --html       ):  Output an html string
    ( -h |      --help       ):  Print help message
    ( -m |     --module      ):  View code from a module
                                  - will attempt to automagically parse this without the option given
    ( -n | --no-highlighting ):  Disable syntax highlighting in output
                                  - only effects output - string data is still processed
                                  - default = False
    ( -p |    --filepath     ):  View file contents
                                  - path can also be provided without this option
    ( -s |     --string      ):  Code view from a provided string
    (    |     --version     ):  Print version info and exit

```

>   If the options `-p|--filepath`, `-m|--module`, or `-f|--function` are ommitted, it will attempt to automatically assign
> the arguments properly. May not work depending on the module name/path. Pathnames are almost guaranteed to work on their own.

### TODO

- theming
- comments are not removed when `--no-highlighting` option is used
    - syntax highlighter is what removed them - might rewrite this

## ChangeLog

##### v0.1.0
    - initial release

##### v0.1.1
    - added html output
    - added licenses

##### v0.1.2
    - added `--version` option

##### v0.1.3
    - made html look nicer
    - fixed `--no-highlighting` option for html output
    - `--no-highlighting` option now skips syntax highlighter processing
    - added `__call__` method to SyntaxHighlighter
        - same as calling `SyntaxHighlighter.highlight()`
    - fixes for method lookup
    - added `-a`|`--attribute` options for searching attributes

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "BB-PyCodeView",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Erik Beebe",
    "author_email": "beebeapps_debugging@tuta.io",
    "download_url": "https://files.pythonhosted.org/packages/7f/ed/7a171e14c09efbad9c9f51b9090cedbb120dc96a2c0d818257aa64a51280/bb_pycodeview-0.1.3.tar.gz",
    "platform": null,
    "description": "# BB-PyCodeView\n\n> View syntax highlighted code from a filename or module name\n\n### Options\n\n```console\n$ code-view --help\n\n    code-view - view highlighted python code\n\n    ( -c |    --comments     ):  Show comments in output\n                                  - default = False\n    ( -f |    --function     ):  Function name - same as adding ':function' after module name\n    ( -H |      --html       ):  Output an html string\n    ( -h |      --help       ):  Print help message\n    ( -m |     --module      ):  View code from a module\n                                  - will attempt to automagically parse this without the option given\n    ( -n | --no-highlighting ):  Disable syntax highlighting in output\n                                  - only effects output - string data is still processed\n                                  - default = False\n    ( -p |    --filepath     ):  View file contents\n                                  - path can also be provided without this option\n    ( -s |     --string      ):  Code view from a provided string\n    (    |     --version     ):  Print version info and exit\n\n```\n\n>   If the options `-p|--filepath`, `-m|--module`, or `-f|--function` are ommitted, it will attempt to automatically assign\n> the arguments properly. May not work depending on the module name/path. Pathnames are almost guaranteed to work on their own.\n\n### TODO\n\n- theming\n- comments are not removed when `--no-highlighting` option is used\n    - syntax highlighter is what removed them - might rewrite this\n\n## ChangeLog\n\n##### v0.1.0\n    - initial release\n\n##### v0.1.1\n    - added html output\n    - added licenses\n\n##### v0.1.2\n    - added `--version` option\n\n##### v0.1.3\n    - made html look nicer\n    - fixed `--no-highlighting` option for html output\n    - `--no-highlighting` option now skips syntax highlighter processing\n    - added `__call__` method to SyntaxHighlighter\n        - same as calling `SyntaxHighlighter.highlight()`\n    - fixes for method lookup\n    - added `-a`|`--attribute` options for searching attributes\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "View highlighted python code",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4021397f200c35c9a91c315a5c15db242bb27c5bbb647c56517f5101479dc268",
                "md5": "6d30ba86ee49b80d257846688ad0edf1",
                "sha256": "06f7d16950ec9ba91aac855b406354aae458c071ad742f39f8b09ed33e3a75f7"
            },
            "downloads": -1,
            "filename": "bb_pycodeview-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6d30ba86ee49b80d257846688ad0edf1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 68054,
            "upload_time": "2024-02-19T08:12:00",
            "upload_time_iso_8601": "2024-02-19T08:12:00.871459Z",
            "url": "https://files.pythonhosted.org/packages/40/21/397f200c35c9a91c315a5c15db242bb27c5bbb647c56517f5101479dc268/bb_pycodeview-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7fed7a171e14c09efbad9c9f51b9090cedbb120dc96a2c0d818257aa64a51280",
                "md5": "7a65557ec850dd170f17d386480f520f",
                "sha256": "e64f06e175fe0da616616b1273cf089d18a8bb3e04b76fe37e56507c66c50345"
            },
            "downloads": -1,
            "filename": "bb_pycodeview-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "7a65557ec850dd170f17d386480f520f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 67903,
            "upload_time": "2024-02-19T08:12:02",
            "upload_time_iso_8601": "2024-02-19T08:12:02.565933Z",
            "url": "https://files.pythonhosted.org/packages/7f/ed/7a171e14c09efbad9c9f51b9090cedbb120dc96a2c0d818257aa64a51280/bb_pycodeview-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-19 08:12:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bb-pycodeview"
}
        
Elapsed time: 0.18516s