prefect-shell 0.3.0__tar.gz

prefect_shell-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Prefect Technologies, Inc.
+
+   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.

prefect_shell-0.3.0/MANIFEST.in

@@ -0,0 +1,9 @@
+# Things to always exclude
+global-exclude .git*
+global-exclude .ipynb_checkpoints
+global-exclude *.py[co]
+global-exclude __pycache__/**
+
+# Top-level Config
+include LICENSE
+include MANIFEST.in

prefect_shell-0.3.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.1
+Name: prefect-shell
+Version: 0.3.0
+Summary: Prefect integrations for interacting with shell commands.
+Author-email: "Prefect Technologies, Inc." <help@prefect.io>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/PrefectHQ/prefect/tree/main/src/integrations/prefect-shell
+Keywords: prefect
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prefect>=3.0.0rc1
+Provides-Extra: dev
+Requires-Dist: aiohttp; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: interrogate; extra == "dev"
+Requires-Dist: mkdocs-gen-files; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pillow; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-env; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+
+# Integrating shell commands into your dataflow with `prefect-shell`
+
+<p align="center">
+    <a href="https://pypi.python.org/pypi/prefect-shell/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-shell?color=0052FF&labelColor=090422"></a>
+    <a href="https://pepy.tech/badge/prefect-shell/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-shell?color=0052FF&labelColor=090422" /></a>
+</p>
+
+Visit the full docs [here](https://PrefectHQ.github.io/prefect-shell) to see additional examples and the API reference.
+
+The prefect-shell collection makes it easy to execute shell commands in your Prefect flows. Check out the examples below to get started!
+
+## Getting Started
+
+### Integrate with Prefect flows
+
+With prefect-shell, you can bring your trusty shell commands (and/or scripts) straight into the Prefect flow party, complete with awesome Prefect logging.
+
+No more separate logs, just seamless integration. Let's get the shell-abration started!
+
+```python
+from prefect import flow
+from datetime import datetime
+from prefect_shell import ShellOperation
+
+@flow
+def download_data():
+    today = datetime.today().strftime("%Y%m%d")
+
+    # for short running operations, you can use the `run` method
+    # which automatically manages the context
+    ShellOperation(
+        commands=[
+            "mkdir -p data",
+            "mkdir -p data/${today}"
+        ],
+        env={"today": today}
+    ).run()
+
+    # for long running operations, you can use a context manager
+    with ShellOperation(
+        commands=[
+            "curl -O https://masie_web.apps.nsidc.org/pub/DATASETS/NOAA/G02135/north/daily/data/N_seaice_extent_daily_v3.0.csv",
+        ],
+        working_dir=f"data/{today}",
+    ) as download_csv_operation:
+
+        # trigger runs the process in the background
+        download_csv_process = download_csv_operation.trigger()
+
+        # then do other things here in the meantime, like download another file
+        ...
+
+        # when you're ready, wait for the process to finish
+        download_csv_process.wait_for_completion()
+
+        # if you'd like to get the output lines, you can use the `fetch_result` method
+        output_lines = download_csv_process.fetch_result()
+
+download_data()
+```
+
+Outputs:
+```bash
+14:48:16.550 | INFO    | prefect.engine - Created flow run 'tentacled-chachalaca' for flow 'download-data'
+14:48:17.977 | INFO    | Flow run 'tentacled-chachalaca' - PID 19360 triggered with 2 commands running inside the '.' directory.
+14:48:17.987 | INFO    | Flow run 'tentacled-chachalaca' - PID 19360 completed with return code 0.
+14:48:17.994 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 triggered with 1 commands running inside the PosixPath('data/20230201') directory.
+14:48:18.009 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dl
+14:48:18.010 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+oad  Upload   Total   Spent    Left  Speed
+  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
+14:48:18.840 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+ 11 1630k   11  192k    0     0   229k      0  0:00:07 --:--:--  0:00:07  231k
+14:48:19.839 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+ 83 1630k   83 1368k    0     0   745k      0  0:00:02  0:00:01  0:00:01  747k
+14:48:19.993 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+100 1630k  100 1630k    0     0   819k      0  0
+14:48:19.994 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+:00:01  0:00:01 --:--:--  821k
+14:48:19.996 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 completed with return code 0.
+14:48:19.998 | INFO    | Flow run 'tentacled-chachalaca' - Successfully closed all open processes.
+14:48:20.203 | INFO    | Flow run 'tentacled-chachalaca' - Finished in state Completed()
+```
+
+!!! info "Utilize Previously Saved Blocks"
+
+    You can save commands within a `ShellOperation` block, then reuse them across multiple flows, or even plain Python scripts.
+    
+    Save the block with desired commands:
+
+    ```python
+    from prefect_shell import ShellOperation
+
+    ping_op = ShellOperation(commands=["ping -t 1 prefect.io"])
+    ping_op.save("block-name")
+    ```
+
+    Load the saved block:
+
+    ```python
+    from prefect_shell import ShellOperation
+
+    ping_op = ShellOperation.load("block-name")
+    ```
+
+    To [view and edit the blocks](https://orion-docs.prefect.io/ui/blocks/) on Prefect UI:
+
+    ```bash
+    prefect block register -m prefect_shell
+    ```
+
+## Resources
+
+For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://orion-docs.prefect.io/collections/usage/)!
+
+### Installation
+
+Install `prefect-shell` with `pip`:
+
+```bash
+pip install -U prefect-shell
+```
+
+A list of available blocks in `prefect-shell` and their setup instructions can be found [here](https://PrefectHQ.github.io/prefect-shell/blocks_catalog).
+
+Requires an installation of Python 3.7+.
+
+We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
+
+These tasks are designed to work with Prefect 2. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).
+
+### Feedback
+
+If you encounter any bugs while using `prefect-shell`, feel free to open an issue in the [prefect-shell](https://github.com/PrefectHQ/prefect-shell) repository.
+
+If you have any questions or issues while using `prefect-shell`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
+
+Feel free to star or watch [`prefect-shell`](https://github.com/PrefectHQ/prefect-shell) for updates too!
+ 
+### Contributing
+ 
+If you'd like to help contribute to fix an issue or add a feature to `prefect-shell`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+ 
+Here are the steps:
+
+1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
+2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
+3. Install the repository and its dependencies:
+```
+pip install -e ".[dev]"
+```
+4. Make desired changes
+5. Add tests
+6. Insert an entry to [CHANGELOG.md](https://github.com/PrefectHQ/prefect-shell/blob/main/CHANGELOG.md)
+7. Install `pre-commit` to perform quality checks prior to commit:
+```
+pre-commit install
+```
+8. `git commit`, `git push`, and create a pull request

prefect_shell-0.3.0/README.md

@@ -0,0 +1,163 @@
+# Integrating shell commands into your dataflow with `prefect-shell`
+
+<p align="center">
+    <a href="https://pypi.python.org/pypi/prefect-shell/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-shell?color=0052FF&labelColor=090422"></a>
+    <a href="https://pepy.tech/badge/prefect-shell/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-shell?color=0052FF&labelColor=090422" /></a>
+</p>
+
+Visit the full docs [here](https://PrefectHQ.github.io/prefect-shell) to see additional examples and the API reference.
+
+The prefect-shell collection makes it easy to execute shell commands in your Prefect flows. Check out the examples below to get started!
+
+## Getting Started
+
+### Integrate with Prefect flows
+
+With prefect-shell, you can bring your trusty shell commands (and/or scripts) straight into the Prefect flow party, complete with awesome Prefect logging.
+
+No more separate logs, just seamless integration. Let's get the shell-abration started!
+
+```python
+from prefect import flow
+from datetime import datetime
+from prefect_shell import ShellOperation
+
+@flow
+def download_data():
+    today = datetime.today().strftime("%Y%m%d")
+
+    # for short running operations, you can use the `run` method
+    # which automatically manages the context
+    ShellOperation(
+        commands=[
+            "mkdir -p data",
+            "mkdir -p data/${today}"
+        ],
+        env={"today": today}
+    ).run()
+
+    # for long running operations, you can use a context manager
+    with ShellOperation(
+        commands=[
+            "curl -O https://masie_web.apps.nsidc.org/pub/DATASETS/NOAA/G02135/north/daily/data/N_seaice_extent_daily_v3.0.csv",
+        ],
+        working_dir=f"data/{today}",
+    ) as download_csv_operation:
+
+        # trigger runs the process in the background
+        download_csv_process = download_csv_operation.trigger()
+
+        # then do other things here in the meantime, like download another file
+        ...
+
+        # when you're ready, wait for the process to finish
+        download_csv_process.wait_for_completion()
+
+        # if you'd like to get the output lines, you can use the `fetch_result` method
+        output_lines = download_csv_process.fetch_result()
+
+download_data()
+```
+
+Outputs:
+```bash
+14:48:16.550 | INFO    | prefect.engine - Created flow run 'tentacled-chachalaca' for flow 'download-data'
+14:48:17.977 | INFO    | Flow run 'tentacled-chachalaca' - PID 19360 triggered with 2 commands running inside the '.' directory.
+14:48:17.987 | INFO    | Flow run 'tentacled-chachalaca' - PID 19360 completed with return code 0.
+14:48:17.994 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 triggered with 1 commands running inside the PosixPath('data/20230201') directory.
+14:48:18.009 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dl
+14:48:18.010 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+oad  Upload   Total   Spent    Left  Speed
+  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
+14:48:18.840 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+ 11 1630k   11  192k    0     0   229k      0  0:00:07 --:--:--  0:00:07  231k
+14:48:19.839 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+ 83 1630k   83 1368k    0     0   745k      0  0:00:02  0:00:01  0:00:01  747k
+14:48:19.993 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+100 1630k  100 1630k    0     0   819k      0  0
+14:48:19.994 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 stream output:
+:00:01  0:00:01 --:--:--  821k
+14:48:19.996 | INFO    | Flow run 'tentacled-chachalaca' - PID 19363 completed with return code 0.
+14:48:19.998 | INFO    | Flow run 'tentacled-chachalaca' - Successfully closed all open processes.
+14:48:20.203 | INFO    | Flow run 'tentacled-chachalaca' - Finished in state Completed()
+```
+
+!!! info "Utilize Previously Saved Blocks"
+
+    You can save commands within a `ShellOperation` block, then reuse them across multiple flows, or even plain Python scripts.
+    
+    Save the block with desired commands:
+
+    ```python
+    from prefect_shell import ShellOperation
+
+    ping_op = ShellOperation(commands=["ping -t 1 prefect.io"])
+    ping_op.save("block-name")
+    ```
+
+    Load the saved block:
+
+    ```python
+    from prefect_shell import ShellOperation
+
+    ping_op = ShellOperation.load("block-name")
+    ```
+
+    To [view and edit the blocks](https://orion-docs.prefect.io/ui/blocks/) on Prefect UI:
+
+    ```bash
+    prefect block register -m prefect_shell
+    ```
+
+## Resources
+
+For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://orion-docs.prefect.io/collections/usage/)!
+
+### Installation
+
+Install `prefect-shell` with `pip`:
+
+```bash
+pip install -U prefect-shell
+```
+
+A list of available blocks in `prefect-shell` and their setup instructions can be found [here](https://PrefectHQ.github.io/prefect-shell/blocks_catalog).
+
+Requires an installation of Python 3.7+.
+
+We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
+
+These tasks are designed to work with Prefect 2. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).
+
+### Feedback
+
+If you encounter any bugs while using `prefect-shell`, feel free to open an issue in the [prefect-shell](https://github.com/PrefectHQ/prefect-shell) repository.
+
+If you have any questions or issues while using `prefect-shell`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
+
+Feel free to star or watch [`prefect-shell`](https://github.com/PrefectHQ/prefect-shell) for updates too!
+ 
+### Contributing
+ 
+If you'd like to help contribute to fix an issue or add a feature to `prefect-shell`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
+ 
+Here are the steps:
+
+1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
+2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
+3. Install the repository and its dependencies:
+```
+pip install -e ".[dev]"
+```
+4. Make desired changes
+5. Add tests
+6. Insert an entry to [CHANGELOG.md](https://github.com/PrefectHQ/prefect-shell/blob/main/CHANGELOG.md)
+7. Install `pre-commit` to perform quality checks prior to commit:
+```
+pre-commit install
+```
+8. `git commit`, `git push`, and create a pull request

prefect_shell-0.3.0/prefect_shell/__init__.py

@@ -0,0 +1,4 @@
+from . import _version
+from .commands import shell_run_command, ShellOperation  # noqa
+
+__version__ = _version.__version__

prefect_shell-0.3.0/prefect_shell/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)