| Name | wxc JSON |
| Version |
7.1.2
JSON |
| download |
| home_page | None |
| Summary | A CLI facility to inspect Python environments. |
| upload_time | 2024-05-17 07:48:13 |
| maintainer | None |
| docs_url | None |
| author | C.M.T. Robert |
| requires_python | >=3.10 |
| license | GPL-3.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# wxc
[](https://pypi.org/project/wxc/)
[](https://github.com/neutrinoceros/wxc/pulls)
[](https://results.pre-commit.ci/latest/github/neutrinoceros/wxc/main)
[](https://github.com/charliermarsh/ruff)
`wxc` (pronounced "which") allows you to inspect source code in your Python
environment from the command line. It is based on the `inspect` module from the
standard library.
## Installation
```shell
$ python -m pip install wxc
```
## Usage
Get the version number of a package in your current environment
<p align="center">
<img src="https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_version.png" width="800"></a>
</p>
Locate the file from which a Python package is imported
<p align="center">
<img src="https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_loc.png" width="800"></a>
</p>
Locate a specific method's source code
<p align="center">
<img src="https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_method.png" width="800"></a>
</p>
View the source code of function directly from the terminal stdout
<p align="center">
<img src="https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_source.png" width="800"></a>
</p>
`wxc` tries to be helpful when you mistype
<p align="center">
<img src="https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_resilience.png" width="800"></a>
</p>
For more, run
```shell
$ wxc --help
```
## Known limitations
`wxc` is not currently able to retrieve the source of compiled code binded into
Python. It should however correctly point to the compiled file that an object is
imported from.
`wxc` should never be installed in isolation (for instance via
[pipx](https://pipxproject.github.io/pipx/)) since it would completely defeat
its purpose.
## Notes
- `wxc` is fully tested on macOS, Linux, and partially on Windows
- this project was formerly named "whych" and renamed to avoid confusion with the
pypi-available package of the same name.
Raw data
{
"_id": null,
"home_page": null,
"name": "wxc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "C.M.T. Robert",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/29/a5/6cfb75754a7534cf3d2f810fc673d346983122ce81cc38d54cfaa6496d0c/wxc-7.1.2.tar.gz",
"platform": null,
"description": "# wxc\n\n[](https://pypi.org/project/wxc/)\n[](https://github.com/neutrinoceros/wxc/pulls)\n\n[](https://results.pre-commit.ci/latest/github/neutrinoceros/wxc/main)\n[](https://github.com/charliermarsh/ruff)\n\n\n`wxc` (pronounced \"which\") allows you to inspect source code in your Python\nenvironment from the command line. It is based on the `inspect` module from the\nstandard library.\n\n\n## Installation\n\n```shell\n$ python -m pip install wxc\n```\n\n## Usage\n\nGet the version number of a package in your current environment\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_version.png\" width=\"800\"></a>\n</p>\n\nLocate the file from which a Python package is imported\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_loc.png\" width=\"800\"></a>\n</p>\n\nLocate a specific method's source code\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_method.png\" width=\"800\"></a>\n</p>\n\nView the source code of function directly from the terminal stdout\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_source.png\" width=\"800\"></a>\n</p>\n\n\n`wxc` tries to be helpful when you mistype\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neutrinoceros/wxc/main/gallery/example_resilience.png\" width=\"800\"></a>\n</p>\n\nFor more, run\n```shell\n$ wxc --help\n```\n\n## Known limitations\n\n`wxc` is not currently able to retrieve the source of compiled code binded into\nPython. It should however correctly point to the compiled file that an object is\nimported from.\n\n`wxc` should never be installed in isolation (for instance via\n[pipx](https://pipxproject.github.io/pipx/)) since it would completely defeat\nits purpose.\n\n## Notes\n\n- `wxc` is fully tested on macOS, Linux, and partially on Windows\n- this project was formerly named \"whych\" and renamed to avoid confusion with the\n pypi-available package of the same name.\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A CLI facility to inspect Python environments.",
"version": "7.1.2",
"project_urls": {
"Changelog": "https://github.com/neutrinoceros/wxc/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/neutrinoceros/wxc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06a1e0430781da6677e20c5b7445e9e976062f21dac31b3662f38f0e65512941",
"md5": "8bddb7b0aab9a1d322f23dba7a45f8c7",
"sha256": "aadc6aa3ba9eeac76ff70af24bb4966419c50f957e46c4833ec987bb55cb084b"
},
"downloads": -1,
"filename": "wxc-7.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bddb7b0aab9a1d322f23dba7a45f8c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 20112,
"upload_time": "2024-05-17T07:48:11",
"upload_time_iso_8601": "2024-05-17T07:48:11.386343Z",
"url": "https://files.pythonhosted.org/packages/06/a1/e0430781da6677e20c5b7445e9e976062f21dac31b3662f38f0e65512941/wxc-7.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29a56cfb75754a7534cf3d2f810fc673d346983122ce81cc38d54cfaa6496d0c",
"md5": "a3fe0cc5c33a662b2fd0ba92dccf1b47",
"sha256": "76f7115a96ff758c2b404a616c3d2cf99a3258d1c6e73cc31b89f923030dfada"
},
"downloads": -1,
"filename": "wxc-7.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a3fe0cc5c33a662b2fd0ba92dccf1b47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23251,
"upload_time": "2024-05-17T07:48:13",
"upload_time_iso_8601": "2024-05-17T07:48:13.202950Z",
"url": "https://files.pythonhosted.org/packages/29/a5/6cfb75754a7534cf3d2f810fc673d346983122ce81cc38d54cfaa6496d0c/wxc-7.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 07:48:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neutrinoceros",
"github_project": "wxc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wxc"
}
