bashhub 3.0.2__tar.gz

bashhub-3.0.2/LICENSE.md

@@ -0,0 +1,190 @@
+                           Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2015 Ryan Caloras
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bashhub-3.0.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include bashhub/shell/*.zsh
+include bashhub/shell/*.sh
+include bashhub/shell/deps/*.sh
+include bashhub/model/*

bashhub-3.0.2/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.4
+Name: bashhub
+Version: 3.0.2
+Summary: Bashhub.com python client
+Author-email: Ryan Caloras <ryan@bashhub.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rcaloras/bashhub-client
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: requests>=2.32.5
+Requires-Dist: jsonpickle>=4.1.1
+Requires-Dist: click>=8.1.8
+Requires-Dist: npyscreen>=5.0.2
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: inflection>=0.5.1
+Requires-Dist: humanize>=4.13.0
+Provides-Extra: test
+Requires-Dist: pytest>=3.3.1; extra == "test"
+Dynamic: license-file
+
+<img src="https://bashhub.com/assets/images/bashhub-logo.png" alt="Bashhub Logo">
+
+Bashhub saves every terminal command entered across all sessions and systems and provides powerful querying across all commands.
+
+[![Build Status](https://github.com/rcaloras/bashhub-client/actions/workflows/main.yml/badge.svg)](https://github.com/rcaloras/bashhub-client/actions/)
+[![GitHub version](https://badge.fury.io/gh/rcaloras%2Fbashhub-client.svg)](https://badge.fury.io/gh/rcaloras%2Fbashhub-client)
+
+### Features
+- Super command search by using context about how commands are executed.
+  - e.g. the directory, session, system, exit status, etc.
+- Unlimited detailed terminal history stored in the cloud.
+  - [Stored privately and encrypted at rest](https://github.com/rcaloras/bashhub-client/wiki/Security-and-Privacy).
+- Support across systems. Access your terminal history from anywhere!
+- Support for Bash and Zsh with a sweet cli for everything.
+
+![gif](http://i.imgur.com/02ABZxn.gif)
+
+# Quick Install
+```shell
+curl -OL https://bashhub.com/setup && $SHELL setup
+```
+For non default login shells, just specify the shell e.g. (`bash setup`, `zsh setup`, `fish setup`)
+
+Detailed installation instructions can be found at
+https://github.com/rcaloras/bashhub-client/wiki/Install
+
+# Usage
+Bashhub can be accessed from the command line in a couple ways:
+
+- `bh` for searching
+- `bashhub` for everything else
+
+It also provides a key binding of `ctrl + b` for quickly dropping into interactive search.
+
+## Search
+You can search through your commands in a lot of different ways. Check `bh --help` for more specifics. By default `bh` will output the most recently used unique commands to standard out. Adding the `-i` argument to any `bh` search will make it **interactive**. There are also several arguments to pass to filter, query, and get more specific about your searches!
+
+## Examples
+
+The last 100 commands you executed anywhere. (100 is default limit without `-n`)
+```bash
+$ bh
+```
+
+The last 20 files I've grep'd.
+```bash
+$ bh -n 20 "grep"
+```
+Find that wget command with interactive search to execute it again :P
+```bash
+$ bh -i "wget github"
+```
+
+### Directory-specific Searching
+
+The last commands you executed in this directory.
+```bash
+$ bh -d
+```
+The last 10 things you vim'd in this directory
+```bash
+$ bh -d -n 10 "vim"
+```
+
+### System-specific Searching
+
+The last 10 curl commands you produced on this system
+
+```bash
+$ bh -sys -n 10 "curl"
+```
+
+### How Search Results are Ordered
+By default results are sorted by **most recently** used, and are **unique**. This means frequent commands like `git status` or `ls` will only appear once in the position they were most recently invoked.
+
+This can be altered by using the `-dups` command to include duplicates
+
+Your git commands including duplicates.
+
+```bash
+$ bh -dups "git"
+```
+
+## Interactive Search
+One of the most useful features is interactive search which is accessed via `bh -i` or `ctrl + b`. This is similar to reverse search i.e. `ctrl + r`. Interactive search drops you into a small menu where you can select a command to run on the command line.
+
+Enter interactive search for all the rsync commands executed in this directory
+```bash
+$ bh -i -d
+(bashhub-i-search): rsync
+```
+
+### Command Details
+From interactive search you can also access detailed information on each command by hitting `i` or `space` on any listed command.
+
+![Command Details](http://i.imgur.com/is0gNnB.png)
+
+
+## Bashhub Status
+You can get a summary of your user's stats/status by using the `status` command.
+```bash
+bashhub status
+```
+Most of this information is also displayed on the user profile page.
+
+```bash
+=== Bashhub Status
+http://bashhub.com/u/rccola
+Total Commands: 94965
+Total Sessions: 16400
+Total Systems:  18
+===
+Session PID 15311 Started 9 days ago
+Commands In Session: 3
+Commands Today: 47
+```
+
+### Search with Fuzzy Finder
+An efficient way of searching is using `bashhub` in combination with [`fzf`](https://github.com/junegunn/fzf). Put this in your `.bashrc`.
+
+```bash
+function my_alias {
+  eval $(bh | fzf)
+}
+```
+
+This will make the function available globally in your terminal.
+
+## Filtering Commands
+You can filter commands from being recorded to Bashhub via a regex set to the environment variable `BH_FILTER`. These commands will be ignored and omittted from Bashhub.
+```bash
+# Filter out any commands for postgres or ssh
+export BH_FILTER="(psql|ssh)"
+ssh rcaloras@some-ip-address # will not be saved
+```
+
+You can check the configuration of this command via the `bashhub filter` subcommand.
+```bash
+# Check if a command is filtered by my regex
+export BH_FILTER="(-p)"
+bashhub filter "mysql -u root -p plain-text-password"
+BH_FILTER=(-p)
+mysql -u root -p plain-text-password
+Is Filtered. Matched ['-p']
+```
+
+## Disabling Recording Commands
+You can turn on/off recording to Bashhub via `bashhub on` and `bashhub off`. By default this only affects the current bash session.
+
+```bash
+$ bashhub off
+$ echo "Recording is now disabled for this session. This command won't be saved."
+....
+$ bashhub on
+$ echo "Recording commands is now re-enabled"
+```
+You can disable for all sessions by setting `bashhub off --global` this sets `save_commands = False` in your bashhub config.
+
+## Ignoring Commands
+`#ignore` added to any command will omit it from being saved. Simply add it to the end of any command and it won't be recorded in Bashhub.
+
+```bash
+$ echo "this command won't be saved" #ignore
+```
+
+## Deleting Commands
+You can delete commands from Bashhub through interactive search by pressing `Delete` or `Backspace` while a command is highlighted. A small dialog box will open to confirm the commands deletion. If a command is deleted, it is permanently removed from Bashhub.
+
+![gif](http://i.imgur.com/sHzvEJx.gif)
+
+## Feature Requests, Bugs, and Issues
+Feel free to post in:
+https://github.com/rcaloras/bashhub-client/issues
+
+You can also get support and follow updates [@Bashhub](https://twitter.com/bashhub) on Twitter.

bashhub-3.0.2/README.md

@@ -0,0 +1,175 @@
+<img src="https://bashhub.com/assets/images/bashhub-logo.png" alt="Bashhub Logo">
+
+Bashhub saves every terminal command entered across all sessions and systems and provides powerful querying across all commands.
+
+[![Build Status](https://github.com/rcaloras/bashhub-client/actions/workflows/main.yml/badge.svg)](https://github.com/rcaloras/bashhub-client/actions/)
+[![GitHub version](https://badge.fury.io/gh/rcaloras%2Fbashhub-client.svg)](https://badge.fury.io/gh/rcaloras%2Fbashhub-client)
+
+### Features
+- Super command search by using context about how commands are executed.
+  - e.g. the directory, session, system, exit status, etc.
+- Unlimited detailed terminal history stored in the cloud.
+  - [Stored privately and encrypted at rest](https://github.com/rcaloras/bashhub-client/wiki/Security-and-Privacy).
+- Support across systems. Access your terminal history from anywhere!
+- Support for Bash and Zsh with a sweet cli for everything.
+
+![gif](http://i.imgur.com/02ABZxn.gif)
+
+# Quick Install
+```shell
+curl -OL https://bashhub.com/setup && $SHELL setup
+```
+For non default login shells, just specify the shell e.g. (`bash setup`, `zsh setup`, `fish setup`)
+
+Detailed installation instructions can be found at
+https://github.com/rcaloras/bashhub-client/wiki/Install
+
+# Usage
+Bashhub can be accessed from the command line in a couple ways:
+
+- `bh` for searching
+- `bashhub` for everything else
+
+It also provides a key binding of `ctrl + b` for quickly dropping into interactive search.
+
+## Search
+You can search through your commands in a lot of different ways. Check `bh --help` for more specifics. By default `bh` will output the most recently used unique commands to standard out. Adding the `-i` argument to any `bh` search will make it **interactive**. There are also several arguments to pass to filter, query, and get more specific about your searches!
+
+## Examples
+
+The last 100 commands you executed anywhere. (100 is default limit without `-n`)
+```bash
+$ bh
+```
+
+The last 20 files I've grep'd.
+```bash
+$ bh -n 20 "grep"
+```
+Find that wget command with interactive search to execute it again :P
+```bash
+$ bh -i "wget github"
+```
+
+### Directory-specific Searching
+
+The last commands you executed in this directory.
+```bash
+$ bh -d
+```
+The last 10 things you vim'd in this directory
+```bash
+$ bh -d -n 10 "vim"
+```
+
+### System-specific Searching
+
+The last 10 curl commands you produced on this system
+
+```bash
+$ bh -sys -n 10 "curl"
+```
+
+### How Search Results are Ordered
+By default results are sorted by **most recently** used, and are **unique**. This means frequent commands like `git status` or `ls` will only appear once in the position they were most recently invoked.
+
+This can be altered by using the `-dups` command to include duplicates
+
+Your git commands including duplicates.
+
+```bash
+$ bh -dups "git"
+```
+
+## Interactive Search
+One of the most useful features is interactive search which is accessed via `bh -i` or `ctrl + b`. This is similar to reverse search i.e. `ctrl + r`. Interactive search drops you into a small menu where you can select a command to run on the command line.
+
+Enter interactive search for all the rsync commands executed in this directory
+```bash
+$ bh -i -d
+(bashhub-i-search): rsync
+```
+
+### Command Details
+From interactive search you can also access detailed information on each command by hitting `i` or `space` on any listed command.
+
+![Command Details](http://i.imgur.com/is0gNnB.png)
+
+
+## Bashhub Status
+You can get a summary of your user's stats/status by using the `status` command.
+```bash
+bashhub status
+```
+Most of this information is also displayed on the user profile page.
+
+```bash
+=== Bashhub Status
+http://bashhub.com/u/rccola
+Total Commands: 94965
+Total Sessions: 16400
+Total Systems:  18
+===
+Session PID 15311 Started 9 days ago
+Commands In Session: 3
+Commands Today: 47
+```
+
+### Search with Fuzzy Finder
+An efficient way of searching is using `bashhub` in combination with [`fzf`](https://github.com/junegunn/fzf). Put this in your `.bashrc`.
+
+```bash
+function my_alias {
+  eval $(bh | fzf)
+}
+```
+
+This will make the function available globally in your terminal.
+
+## Filtering Commands
+You can filter commands from being recorded to Bashhub via a regex set to the environment variable `BH_FILTER`. These commands will be ignored and omittted from Bashhub.
+```bash
+# Filter out any commands for postgres or ssh
+export BH_FILTER="(psql|ssh)"
+ssh rcaloras@some-ip-address # will not be saved
+```
+
+You can check the configuration of this command via the `bashhub filter` subcommand.
+```bash
+# Check if a command is filtered by my regex
+export BH_FILTER="(-p)"
+bashhub filter "mysql -u root -p plain-text-password"
+BH_FILTER=(-p)
+mysql -u root -p plain-text-password
+Is Filtered. Matched ['-p']
+```
+
+## Disabling Recording Commands
+You can turn on/off recording to Bashhub via `bashhub on` and `bashhub off`. By default this only affects the current bash session.
+
+```bash
+$ bashhub off
+$ echo "Recording is now disabled for this session. This command won't be saved."
+....
+$ bashhub on
+$ echo "Recording commands is now re-enabled"
+```
+You can disable for all sessions by setting `bashhub off --global` this sets `save_commands = False` in your bashhub config.
+
+## Ignoring Commands
+`#ignore` added to any command will omit it from being saved. Simply add it to the end of any command and it won't be recorded in Bashhub.
+
+```bash
+$ echo "this command won't be saved" #ignore
+```
+
+## Deleting Commands
+You can delete commands from Bashhub through interactive search by pressing `Delete` or `Backspace` while a command is highlighted. A small dialog box will open to confirm the commands deletion. If a command is deleted, it is permanently removed from Bashhub.
+
+![gif](http://i.imgur.com/sHzvEJx.gif)
+
+## Feature Requests, Bugs, and Issues
+Feel free to post in:
+https://github.com/rcaloras/bashhub-client/issues
+
+You can also get support and follow updates [@Bashhub](https://twitter.com/bashhub) on Twitter.