Home  /  Resources & support  /  Use Python and Stata together

Use Python and Stata together

Stata provides two ways for Python and Stata to interact, and we refer to these mechanisms collectively as PyStata.

First, Python can be invoked from a running Stata session so that Python's extensive language features can be leveraged from within Stata. We call this Python integration, which was introduced in Stata 16. With this integration, you can embed and execute Python code interactively or in do-files and ado-files. You can read more about using Python from within Stata in [P] PyStata integration.

Second, in Stata 17 or higher, Stata can be invoked from a standalone Python environment via the pystata Python package. It includes three IPython (interactive Python) magic commands and a suite of API functions for interacting with Stata from within Python. With these tools, you can access Stata and Mata conveniently in an IPython kernel-based environment (for example, Jupyter Notebook and console, and Jupyter Lab and console), in other environments that support the IPython kernel (for example, Spyder IDE and PyCharm IDE), or when accessing Python from a command line (for example, Windows Command Prompt, macOS terminal, Unix terminal, and Python's IDLE). See [P] PyStata module for more details about calling Stata from within Python.

Whether you are integrating Python into Stata or Stata into Python, you can use the sfi (Stata Function Interface) module to interact Python’s capabilities with Stata’s core features. Within the module, classes are defined to provide access to Stata’s current dataset, frames, macros, scalars, matrices, value labels, characteristics, global Mata matrices, and more. Refer to Stata’s Python API documentation for more details.

Both the pystata Python package and Stata's Python API module have capabilities that are specific to the Stata you are currently using. The functionality within them are intended to be forward compatible, but not backward compatible. That is, a feature added in an older Stata may be used with a modern Stata; however, a feature added in a modern Stata may not be used with an older Stata.

Stata 18, pystata Python package documentation
Stata 17, pystata Python package documentation

Stata 18, Stata-Python API documentation
Stata 17, Stata-Python API documentation
Stata 16, Stata-Python API documentation