About
-----
The ``beu`` package is intended to be an easy way to explore several
complementary Python packages.
- There is a script to help you get all the system requirements
installed
- The ``beu`` module auto-imports several relevant modules as their
preferred 2-character (or 3-character) shortcuts for quick
interaction
- The ``beu-ipython`` command is a shortcut to start an ``ipython``
session with the ``beu`` module imported before you see the shell
prompt
- The commands provided by the other packages are all installed to the
same place
- All the advanced features of the packages are made available (since
some packages will do more when certain other packages can be
imported)
See the following docs:
- https://github.com/kenjyco/input-helper/blob/master/README.md#usage
- https://github.com/kenjyco/bg-helper/blob/master/README.md#usage
- https://github.com/kenjyco/settings-helper/blob/master/README.md
- https://github.com/kenjyco/redis-helper/blob/master/README.md#intro
- https://github.com/kenjyco/chloop/blob/master/README.md#usage
- https://github.com/kenjyco/parse-helper/blob/master/README.md#usage
- https://github.com/kenjyco/yt-helper/blob/master/README.md#usage
- https://github.com/kenjyco/dt-helper/blob/master/README.md
- https://github.com/kenjyco/fs-helper/blob/master/README.md
- https://github.com/kenjyco/aws-info-helper/blob/master/README.md
- https://github.com/kenjyco/webclient-helper/blob/master/README.md
- https://github.com/kenjyco/mongo-helper#usage
- https://github.com/kenjyco/sql-helper#usage
- https://github.com/kenjyco/readme-helper#usage
- https://github.com/kenjyco/testing-helper#usage
- https://github.com/kenjyco/mocp/blob/master/README.md#usage
- https://github.com/kenjyco/mocp-cli/blob/master/README.md#usage
- https://github.com/kenjyco/vlc-helper/blob/master/README.md#usage
Install
-------
Install system requirements and install ``beu`` package to ``~/.beu``
(Debian-based distros and Mac). Also modify one of ``~/.zshrc``,
``~/.bashrc``, or ``~/.bash_profile``.
::
% curl -o- https://raw.githubusercontent.com/kenjyco/beu/master/install.sh | bash
Source the ``wrappers.sh`` file
::
% source ~/.beu/wrappers.sh
Mac Note
^^^^^^^^
VLC related things (vlc-helper package, system dbus, etc) are not
installed since VLC cannot be controlled with dbus on mac
Linux Cloud Note
^^^^^^^^^^^^^^^^
VLC related things (vlc-helper package, system dbus, etc) and MOC
related things (mocp & mocp-cli packages, system moc) are not installed
since you can’t watch videos or listen to audio.
Usage
-----
The ``beu-ipython`` script is provided (with the ``b`` shortcut set in
``~/.beu/wrappers.sh``)
::
% b --help
Usage: beu-ipython [OPTIONS]
Start ipython with `beu` and `pprint` imported
Options:
--no-vi Do not use vi editing mode
--no-colors Do not use colors / syntax highlighting
--help Show this message and exit.
::
% b
Python 3.6.8 (default, Jan 14 2019, 17:05:23)
Type "copyright", "credits" or "license" for more information.
IPython 7.6.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]: beu.ih
Out[1]: <module 'input_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/input_helper/__init__.py'>
In [2]: beu.bh
Out[2]: <module 'bg_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/bg_helper/__init__.py'>
In [3]: beu.rh
Out[3]: <module 'redis_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/redis_helper/__init__.py'>
In [4]: beu.chloop
Out[4]: <module 'chloop' from '/tmp/stuff/venv/lib/python3.6/site-packages/chloop/__init__.py'>
In [5]: beu.ph
Out[5]: <module 'parse_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/parse_helper/__init__.py'>
In [6]: beu.yh
Out[6]: <module 'yt_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/yt_helper/__init__.py'>
In [7]: beu.fh
Out[7]: <module 'fs_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/fs_helper/__init__.py'>
In [8]: beu.dh
Out[8]: <module 'dt_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/dt_helper/__init__.py'>
In [9]: beu.sh
Out[9]: <module 'settings_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/settings_helper/__init__.py'>
In [10]: beu.ah
Out[10]: <module 'aws_info_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/aws_info_helper/__init__.py'>
In [11]: beu.jh
Out[11]: <module 'jira_helper' from '/tmp/stuff/venv/lib/python3.6//site-packages/jira_helper/__init__.py'>
In [12]: beu.ewm
Out[12]: <module 'easy_workflow_manager' from '/tmp/stuff/venv/lib/python3.6/site-packages/easy_workflow_manager/__init__.py'>
In [13]: beu.mh
Out[13]: <module 'mongo_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/mongo_helper/__init__.py'>
In [14]: beu.sqh
Out[14]: <module 'sql_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/sql_helper/__init__.py'>
In [15]: beu.moc
Out[15]: <module 'moc' from '/tmp/stuff/venv/lib/python3.6/site-packages/moc/__init__.py'>
In [16]: beu.mocp_cli
Out[16]: <module 'mocp_cli' from '/tmp/stuff/venv/lib/python3.6/site-packages/mocp_cli/__init__.py'>
In [17]: beu.vh
Out[17]: <module 'vlc_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/vlc_helper/__init__.py'>
In [18]: beu.wh
Out[18]: <module 'webclient_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/webclient_helper/__init__.py'>
In [19]: beu.th
Out[19]: <module 'testing_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/testing_helper/__init__.py'>
In [20]: beu.rmh
Out[20]: <module 'readme_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/readme_helper/__init__.py'>
Updating
--------
Use ``beu-update`` to get the latest changes
::
% beu-update
Misc
----
You should be able to pass the ``--help`` option to any of the
command/shortcuts listed below for more info.
- Use ``m`` (``mocplayer``) to start the REPL to control audio playback
and making annotations
- Use ``rh-shell`` to explore Collection objects
..
Note: see the
`wrappers.sh <https://raw.githubusercontent.com/kenjyco/beu/master/wrappers.sh>`__
file to see all defined shortcuts.
Raw data
{
"_id": null,
"home_page": "https://github.com/kenjyco/beu",
"name": "beu",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "kenjyco",
"author": "Ken",
"author_email": "kenjyco@gmail.com",
"download_url": "https://github.com/kenjyco/beu/tarball/v0.1.36",
"platform": null,
"description": "About\n-----\n\nThe ``beu`` package is intended to be an easy way to explore several\ncomplementary Python packages.\n\n- There is a script to help you get all the system requirements\n installed\n- The ``beu`` module auto-imports several relevant modules as their\n preferred 2-character (or 3-character) shortcuts for quick\n interaction\n- The ``beu-ipython`` command is a shortcut to start an ``ipython``\n session with the ``beu`` module imported before you see the shell\n prompt\n- The commands provided by the other packages are all installed to the\n same place\n- All the advanced features of the packages are made available (since\n some packages will do more when certain other packages can be\n imported)\n\nSee the following docs:\n\n- https://github.com/kenjyco/input-helper/blob/master/README.md#usage\n- https://github.com/kenjyco/bg-helper/blob/master/README.md#usage\n- https://github.com/kenjyco/settings-helper/blob/master/README.md\n- https://github.com/kenjyco/redis-helper/blob/master/README.md#intro\n- https://github.com/kenjyco/chloop/blob/master/README.md#usage\n- https://github.com/kenjyco/parse-helper/blob/master/README.md#usage\n- https://github.com/kenjyco/yt-helper/blob/master/README.md#usage\n- https://github.com/kenjyco/dt-helper/blob/master/README.md\n- https://github.com/kenjyco/fs-helper/blob/master/README.md\n- https://github.com/kenjyco/aws-info-helper/blob/master/README.md\n- https://github.com/kenjyco/webclient-helper/blob/master/README.md\n- https://github.com/kenjyco/mongo-helper#usage\n- https://github.com/kenjyco/sql-helper#usage\n- https://github.com/kenjyco/readme-helper#usage\n- https://github.com/kenjyco/testing-helper#usage\n- https://github.com/kenjyco/mocp/blob/master/README.md#usage\n- https://github.com/kenjyco/mocp-cli/blob/master/README.md#usage\n- https://github.com/kenjyco/vlc-helper/blob/master/README.md#usage\n\nInstall\n-------\n\nInstall system requirements and install ``beu`` package to ``~/.beu``\n(Debian-based distros and Mac). Also modify one of ``~/.zshrc``,\n``~/.bashrc``, or ``~/.bash_profile``.\n\n::\n\n % curl -o- https://raw.githubusercontent.com/kenjyco/beu/master/install.sh | bash\n\nSource the ``wrappers.sh`` file\n\n::\n\n % source ~/.beu/wrappers.sh\n\nMac Note\n^^^^^^^^\n\nVLC related things (vlc-helper package, system dbus, etc) are not\ninstalled since VLC cannot be controlled with dbus on mac\n\nLinux Cloud Note\n^^^^^^^^^^^^^^^^\n\nVLC related things (vlc-helper package, system dbus, etc) and MOC\nrelated things (mocp & mocp-cli packages, system moc) are not installed\nsince you can\u2019t watch videos or listen to audio.\n\nUsage\n-----\n\nThe ``beu-ipython`` script is provided (with the ``b`` shortcut set in\n``~/.beu/wrappers.sh``)\n\n::\n\n % b --help\n Usage: beu-ipython [OPTIONS]\n\n Start ipython with `beu` and `pprint` imported\n\n Options:\n --no-vi Do not use vi editing mode\n --no-colors Do not use colors / syntax highlighting\n --help Show this message and exit.\n\n::\n\n % b\n Python 3.6.8 (default, Jan 14 2019, 17:05:23)\n Type \"copyright\", \"credits\" or \"license\" for more information.\n\n IPython 7.6.0 -- An enhanced Interactive Python. Type '?' for help.\n\n In [1]: beu.ih\n Out[1]: <module 'input_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/input_helper/__init__.py'>\n\n In [2]: beu.bh\n Out[2]: <module 'bg_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/bg_helper/__init__.py'>\n\n In [3]: beu.rh\n Out[3]: <module 'redis_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/redis_helper/__init__.py'>\n\n In [4]: beu.chloop\n Out[4]: <module 'chloop' from '/tmp/stuff/venv/lib/python3.6/site-packages/chloop/__init__.py'>\n\n In [5]: beu.ph\n Out[5]: <module 'parse_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/parse_helper/__init__.py'>\n\n In [6]: beu.yh\n Out[6]: <module 'yt_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/yt_helper/__init__.py'>\n\n In [7]: beu.fh\n Out[7]: <module 'fs_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/fs_helper/__init__.py'>\n\n In [8]: beu.dh\n Out[8]: <module 'dt_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/dt_helper/__init__.py'>\n\n In [9]: beu.sh\n Out[9]: <module 'settings_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/settings_helper/__init__.py'>\n\n In [10]: beu.ah\n Out[10]: <module 'aws_info_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/aws_info_helper/__init__.py'>\n\n In [11]: beu.jh\n Out[11]: <module 'jira_helper' from '/tmp/stuff/venv/lib/python3.6//site-packages/jira_helper/__init__.py'>\n\n In [12]: beu.ewm\n Out[12]: <module 'easy_workflow_manager' from '/tmp/stuff/venv/lib/python3.6/site-packages/easy_workflow_manager/__init__.py'>\n\n In [13]: beu.mh\n Out[13]: <module 'mongo_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/mongo_helper/__init__.py'>\n\n In [14]: beu.sqh\n Out[14]: <module 'sql_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/sql_helper/__init__.py'>\n\n In [15]: beu.moc\n Out[15]: <module 'moc' from '/tmp/stuff/venv/lib/python3.6/site-packages/moc/__init__.py'>\n\n In [16]: beu.mocp_cli\n Out[16]: <module 'mocp_cli' from '/tmp/stuff/venv/lib/python3.6/site-packages/mocp_cli/__init__.py'>\n\n In [17]: beu.vh\n Out[17]: <module 'vlc_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/vlc_helper/__init__.py'>\n\n In [18]: beu.wh\n Out[18]: <module 'webclient_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/webclient_helper/__init__.py'>\n\n In [19]: beu.th\n Out[19]: <module 'testing_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/testing_helper/__init__.py'>\n\n In [20]: beu.rmh\n Out[20]: <module 'readme_helper' from '/tmp/stuff/venv/lib/python3.6/site-packages/readme_helper/__init__.py'>\n\nUpdating\n--------\n\nUse ``beu-update`` to get the latest changes\n\n::\n\n % beu-update\n\nMisc\n----\n\nYou should be able to pass the ``--help`` option to any of the\ncommand/shortcuts listed below for more info.\n\n- Use ``m`` (``mocplayer``) to start the REPL to control audio playback\n and making annotations\n- Use ``rh-shell`` to explore Collection objects\n\n..\n\n Note: see the\n `wrappers.sh <https://raw.githubusercontent.com/kenjyco/beu/master/wrappers.sh>`__\n file to see all defined shortcuts.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Beginner Express .:. Back End .:. Big Example .:. Brainstorm Effectively",
"version": "0.1.36",
"project_urls": {
"Download": "https://github.com/kenjyco/beu/tarball/v0.1.36",
"Homepage": "https://github.com/kenjyco/beu"
},
"split_keywords": [
"kenjyco"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7bfd087d08036da1b181ae92525edfed2efd2c3c2575f376e3ee429509b752d",
"md5": "40b0ac66a59be7f1b365d7adfbd03589",
"sha256": "11c0db4f03c18245a6d00651023bc9a0bcf3cbeb1b77efa54701d542724b36da"
},
"downloads": -1,
"filename": "beu-0.1.36-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40b0ac66a59be7f1b365d7adfbd03589",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5195,
"upload_time": "2023-07-10T04:59:23",
"upload_time_iso_8601": "2023-07-10T04:59:23.817572Z",
"url": "https://files.pythonhosted.org/packages/a7/bf/d087d08036da1b181ae92525edfed2efd2c3c2575f376e3ee429509b752d/beu-0.1.36-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-10 04:59:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kenjyco",
"github_project": "beu",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "aws-info-helper",
"specs": []
},
{
"name": "bg-helper",
"specs": []
},
{
"name": "chloop",
"specs": []
},
{
"name": "click",
"specs": []
},
{
"name": "dt-helper",
"specs": []
},
{
"name": "easy-workflow-manager",
"specs": []
},
{
"name": "fs-helper",
"specs": []
},
{
"name": "input-helper",
"specs": []
},
{
"name": "jira-helper",
"specs": []
},
{
"name": "mongo-helper",
"specs": []
},
{
"name": "parse-helper",
"specs": []
},
{
"name": "readme-helper",
"specs": []
},
{
"name": "redis-helper",
"specs": []
},
{
"name": "settings-helper",
"specs": []
},
{
"name": "sql-helper",
"specs": []
},
{
"name": "testing-helper",
"specs": []
},
{
"name": "webclient-helper",
"specs": []
},
{
"name": "yt-helper",
"specs": []
}
],
"lcname": "beu"
}
JSON
