Metadata-Version: 2.1
Name: reprexlite
Version: 0.5.0
Summary: Render reproducible examples of Python code for sharing.
Home-page: https://github.com/jayqi/reprexlite
Author: Jay Qi
Author-email: jayqi.opensource@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/jayqi/reprexlite/issues
Project-URL: Documentation, https://jayqi.github.io/reprexlite/
Project-URL: Source Code, https://github.com/jayqi/reprexlite
Description: # reprexlite: Python reproducible examples for sharing
        
        [![PyPI](https://img.shields.io/pypi/v/reprexlite.svg)](https://pypi.org/project/reprexlite/)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/reprexlite)](https://pypi.org/project/reprexlite/)
        [![tests](https://github.com/jayqi/reprexlite/workflows/tests/badge.svg?branch=main)](https://github.com/jayqi/reprexlite/actions?query=workflow%3Atests+branch%3Amain)
        [![codecov](https://codecov.io/gh/jayqi/reprexlite/branch/main/graph/badge.svg)](https://codecov.io/gh/jayqi/reprexlite)
        
        **reprexlite** is a tool for rendering **repr**oducible **ex**amples of Python code for sharing. With a [convenient CLI](#command-line-interface) and lightweight dependencies, you can quickly get it up and running in any virtual environment. It has an optional [IPython extension with cell magic](#ipythonjupyter-cell-magic) for easy use in Jupyter or VS Code. This project is inspired by R's [reprex](https://reprex.tidyverse.org/).
        
        <img src="https://raw.githubusercontent.com/jayqi/reprexlite/main/docs/docs/images/demo.gif" width="640px" />
        
        - Paste or type some Python code that you're interested in sharing.
        - reprexlite will execute that code in an isolated namespace. Any returned values or standard output will be captured and displayed as comments below their associated code.
        - The rendered reprex will be printed for you to share. Its format can be easily copied, pasted, and run as-is by someone else. Here's an example of an outputted reprex:
        
        ```python
        from itertools import product
        
        grid = list(product([1, 2, 3], [8, 16]))
        grid
        #> [(1, 8), (1, 16), (2, 8), (2, 16), (3, 8), (3, 16)]
        list(zip(*grid))
        #> [(1, 1, 2, 2, 3, 3), (8, 16, 8, 16, 8, 16)]
        ```
        
        Writing a good reprex takes thought and effort (see ["Reprex Do's and Don'ts"](https://jayqi.github.io/reprexlite/stable/dos-and-donts) for tips). The goal of reprexlite is to be a tool that seamlessly handles the mechanical stuff, so you can devote your full attention to the important, creative work of writing the content.
        
        Reprex-style code formatting—namely, with outputs as comments—is also great for documentation. Users can copy and run with no modification. Consider using reprexlite when writing your documentation instead of copying code with `>>>` prompts from an interactive Python shell. In fact, reprexlite can parse code with `>>>` prompts and convert it into a reprex for you instead.
        
        reprexlite is a lightweight alternative to [reprexpy](https://github.com/crew102/reprexpy) and is similarly meant as a port of the R package [reprex](https://github.com/tidyverse/reprex).
        
        ### Why reproducible examples?
        
        If you're asking for help or reporting a bug, you are more likely to succeed in getting others to help you if you include a good reprex. If you're writing documentation, your readers will appreciate examples that they can easily run. See ["Design Philosophy"](https://jayqi.github.io/reprexlite/stable/design-philosophy/) for more on both "Why reproducible examples?" and "Why reprexlite?"
        
        ## Installation
        
        reprexlite is available on PyPI:
        
        ```bash
        pip install reprexlite
        ```
        
        Optional dependencies can be specified using the ["extras" mechanism](https://packaging.python.org/tutorials/installing-packages/#installing-setuptools-extras), e.g., `reprexlite[black]`. Available extras are:
        
        - `black` : for optionally autoformatting your code
        - `ipython` : to use the `%%reprex` cell magic in IPython/Jupyter
        - `pygments` : for syntax highlighting and the RTF venue
        
        ### Development version
        
        The development version of reprexlite is available on GitHub:
        
        ```bash
        pip install https://github.com/jayqi/reprexlite.git#egg=reprexlite
        ```
        
        ## Quick usage
        
        ### Command-line interface
        
        The primary way to use reprexlite is through the CLI. It allows you to create a reprex without entering a Python session. Simply invoke the command:
        
        ```bash
        reprex
        ```
        
        This will take you into your system's default command-line text editor where you can type or paste your Python code. On macOS, for example, this will be `vim`. You can set your default editor using the [`$EDITOR` environment variable](https://askubuntu.com/a/432530)—I'm personally a fan of `nano`.
        
        Once you're done, reprexlite will print out your reprex to console.
        
        To see available options, use the `--help` flag.
        
        ### Python library
        
        The same functionality as the CLI is also available from the `reprex` function with an equivalent API. Simply pass a string with your code, and it will print out the reprex, as well as return a `Reprex` object that contains all the data and formatting machinery. See the [API documentation](https://jayqi.github.io/reprexlite/stable/api-reference/reprex/) for more details.
        
        ```python
        from reprexlite import reprex
        
        code = """
        from itertools import product
        
        grid = list(product([1, 2, 3], [8, 16]))
        grid
        list(zip(*grid))
        """
        
        reprex(code)
        #> ```python
        #> from itertools import product
        #>
        #> grid = list(product([1, 2, 3], [8, 16]))
        #> grid
        #> #> [(1, 8), (1, 16), (2, 8), (2, 16), (3, 8), (3, 16)]
        #> list(zip(*grid))
        #> #> [(1, 1, 2, 2, 3, 3), (8, 16, 8, 16, 8, 16)]
        #> ```
        #>
        #> <sup>Created at 2021-02-26 00:32:00 PST by [reprexlite](https://github.com/jayqi/reprexlite) v0.3.0</sup>
        #> <reprexlite.formatting.GitHubReprex object at 0x109059f10>
        ```
        
        ### IPython/Jupyter Cell Magic
        
        reprexlite has an optional IPython extension with a `%%reprex` cell magic. That means you can easily create a reprex in an [IPython shell](https://ipython.readthedocs.io/en/stable/) (requires IPython), in [Jupyter](https://jupyter.org/) (requires Jupyter), or in [VS Code's Interactive Python window](https://code.visualstudio.com/docs/python/jupyter-support-py) (requires `ipykernel`). This can be handy if you're already working in a Jupyter notebook and want to share some code and output, which otherwise doesn't neatly copy and paste in a nice format.
        
        To use, simply load the extension with
        
        ```python
        %%load_ext reprexlite
        ```
        
        and then put `%%reprex` at the top of a cell you want to create a reprex for:
        
        ```python
        %%reprex
        from itertools import product
        
        grid = list(product([1, 2, 3], [8, 16]))
        grid
        list(zip(*grid))
        ```
        
        The magic accepts the same inline option flags as the CLI. Use the line magic `%reprex` (note single `%`) to print out help. See the [documentation](https://jayqi.github.io/reprexlite/stable/ipython-jupyter-magic/) for more details.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: black
Provides-Extra: pygments
Provides-Extra: ipython
