| Name | pybrownies JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Little helpers for Python developers |
| upload_time | 2023-11-18 17:07:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9,<4 |
| license | None |
| keywords |
helpers
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pybrownies
This is a small library of utilities designed to assist in the creation and maintenance of Python projects. `brownie` performs chores like testing, linting, building, publishing. `pprintenv` shows the shell environment like printenv, but prettier. `whichpy` locates Python packages and modules (like `which` locates program files).
## Installation
A lean install installs just `pprint`, `pprintenv`, and `whichpy`:
```sh
% pip install pybrownies
```
To also get the `brownie` tool and its dependencies to help developing your project, enter
```sh
% pip install pybrownies"[dev]"
```
## Usage
### brownie
To see which `brownie` tasks are available, enter
```sh
% brownie --list
Subcommands:
clean Remove non-code from the project.
covreport Show the coverage report in the default browser.
dist Create the sdist and wheel for the project.
lint Runs pylint and flake8 on every Python package within this
project.
publish Publishes the project on TestPyPI, or on PyPI with the --pypi
option.
test Runs all unit tests, optionally with test coverage.
%
```
To obtain more info on what a specific task does, enter e.g.
```bash
% brownie publish -h
Usage: brownie [--core-opts] publish [--options] [other tasks here ...]
Docstring:
Publishes the project on TestPyPI, or on PyPI with the --pypi option.
Options:
-p, --pypi publish on pypi.org instead of test.pypi.org
-s, --show show the new page in the web browser
%
```
### pprint
Renders various text file formats to the console. with syntax highlighting. Improves the readability os tructured data such as HTML, JSON, PLIST, XML. Applies syntax highlighting to source code. Displays Markdown files with styles and colors appied.
### pprintenv
Outputs the environment as a table, environment variable names in one column, their values in another. For better readability, the elements of a path list (e.g. PATH) are displayed in individual lines.
### whichpy
To locate modules and packages with `whichpy`, enter e.g.
Modules:
```bash
% whichpy shutil
/home/you/.asdf/installs/python/3.10.10/lib/python3.10/shutil.py
```
Packages:
```bash
% whichpy rich
/home/you/dev/pybrownies/.venv3.10/lib/python3.10/site-packages/rich/__init__.py
```
Modules within packages:
```bash
% whichpy rich.console
/home/you/dev/pybrownies/.venv3.10/lib/python3.10/site-packages/rich/console.py
```
## Credits
`brownie` is basically an [invoke](https://pypi.org/project/invoke/) task library. The colorful output is courtesy of [Rich](https://pypi.org/project/rich/).
Raw data
{
"_id": null,
"home_page": null,
"name": "pybrownies",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9,<4",
"maintainer_email": null,
"keywords": "helpers",
"author": null,
"author_email": "Ralf Luetkemeier <foss@rlue.de>",
"download_url": "https://files.pythonhosted.org/packages/a9/b2/58af3be5f0a225eff0a89d742d0d422935bf3aeac7d49e8d5a661e08e52c/pybrownies-0.6.0.tar.gz",
"platform": null,
"description": "# pybrownies\n\nThis is a small library of utilities designed to assist in the creation and maintenance of Python projects. `brownie` performs chores like testing, linting, building, publishing. `pprintenv` shows the shell environment like printenv, but prettier. `whichpy` locates Python packages and modules (like `which` locates program files).\n\n\n## Installation\n\nA lean install installs just `pprint`, `pprintenv`, and `whichpy`:\n\n```sh\n% pip install pybrownies\n```\n\nTo also get the `brownie` tool and its dependencies to help developing your project, enter\n\n```sh\n% pip install pybrownies\"[dev]\"\n```\n\n## Usage\n\n### brownie\n\nTo see which `brownie` tasks are available, enter\n\n```sh\n% brownie --list\nSubcommands:\n\n clean Remove non-code from the project.\n covreport Show the coverage report in the default browser.\n dist Create the sdist and wheel for the project.\n lint Runs pylint and flake8 on every Python package within this\n project.\n publish Publishes the project on TestPyPI, or on PyPI with the --pypi\n option.\n test Runs all unit tests, optionally with test coverage.\n%\n```\n\nTo obtain more info on what a specific task does, enter e.g.\n\n```bash\n% brownie publish -h\nUsage: brownie [--core-opts] publish [--options] [other tasks here ...]\n\nDocstring:\n Publishes the project on TestPyPI, or on PyPI with the --pypi option.\n\nOptions:\n -p, --pypi publish on pypi.org instead of test.pypi.org\n -s, --show show the new page in the web browser\n%\n```\n\n### pprint\n\nRenders various text file formats to the console. with syntax highlighting. Improves the readability os tructured data such as HTML, JSON, PLIST, XML. Applies syntax highlighting to source code. Displays Markdown files with styles and colors appied.\n\n### pprintenv\n\nOutputs the environment as a table, environment variable names in one column, their values in another. For better readability, the elements of a path list (e.g. PATH) are displayed in individual lines.\n\n### whichpy\n\nTo locate modules and packages with `whichpy`, enter e.g.\n\nModules:\n\n```bash\n% whichpy shutil\n/home/you/.asdf/installs/python/3.10.10/lib/python3.10/shutil.py\n```\n\nPackages:\n\n```bash\n% whichpy rich\n/home/you/dev/pybrownies/.venv3.10/lib/python3.10/site-packages/rich/__init__.py\n```\n\nModules within packages:\n\n```bash\n% whichpy rich.console\n/home/you/dev/pybrownies/.venv3.10/lib/python3.10/site-packages/rich/console.py\n```\n\n## Credits\n\n`brownie` is basically an [invoke](https://pypi.org/project/invoke/) task library. The colorful output is courtesy of [Rich](https://pypi.org/project/rich/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Little helpers for Python developers",
"version": "0.6.0",
"project_urls": null,
"split_keywords": [
"helpers"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5955f6199a6722d44811a69216e36267a6a8abc589898d02f8ddfde78a788e9f",
"md5": "94271bb6995efd9914f87fe9a22caa04",
"sha256": "58efd02630d857b5373f964910865639f79039b387b88a3b255856d41a20f832"
},
"downloads": -1,
"filename": "pybrownies-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94271bb6995efd9914f87fe9a22caa04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4",
"size": 11077,
"upload_time": "2023-11-18T17:07:39",
"upload_time_iso_8601": "2023-11-18T17:07:39.365586Z",
"url": "https://files.pythonhosted.org/packages/59/55/f6199a6722d44811a69216e36267a6a8abc589898d02f8ddfde78a788e9f/pybrownies-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9b258af3be5f0a225eff0a89d742d0d422935bf3aeac7d49e8d5a661e08e52c",
"md5": "c461e47fe83d15b3182810a264a43434",
"sha256": "2fe074ebca9c0b69235a1d0f3c8c9dd86d47ec2a43c720a56de187019ff0b5fa"
},
"downloads": -1,
"filename": "pybrownies-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "c461e47fe83d15b3182810a264a43434",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4",
"size": 13985,
"upload_time": "2023-11-18T17:07:41",
"upload_time_iso_8601": "2023-11-18T17:07:41.231105Z",
"url": "https://files.pythonhosted.org/packages/a9/b2/58af3be5f0a225eff0a89d742d0d422935bf3aeac7d49e8d5a661e08e52c/pybrownies-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 17:07:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pybrownies"
}
