# Copy Python Import

A [Sublime Text 4](https://www.sublimetext.com/) package.

Copies a full Python import statement for the symbol under cursor to 
the clipboard.

Supports:

* classes,
* functions,
* methods [^1].
* module-global variables (sometimes called _constants_).
* modules [^2].


[^1]: For class methods, the import statement will point at a class, as 
importing methods directly is impossible.

[^2]: Current module is selected whenever no other syntax element 
(from the list above) can be identified. Thus _module_ is a fallback that 
always works.


# Install

## Via Package Control (recommended)

1. Open _Command Palette_ (<kbd>Ctrl+Shift+P</kbd>).
2. Select **Package Control: Install Package**.
3. Search for **Copy Python Import** and press <kbd>Enter</kbd>.

The package will be installed and kept up-to-date automatically.

## Manual installation

> [!NOTE]
> Use this if Package Control is not available in your setup.

First find your Sublime Text packages directory. 
You can use the built in command:

1. Open _Command Palette_ 
   (e.g. <kbd>Ctrl+Shift+P</kbd> or _Tools_ -> _Command Palette_ in the menu.)
2. Select _Preferences: Browse Packages_
3. Copy the directory path from your file manager
   (e.g. `~/.config/sublime-text/Packages/`)

Now you have a few options to proceed.

### With Git

1. Open a shell and navigate to the aforementioned packages directory.
2. Run:

        git clone git@github.com:odiroot/copy_python_import.git copy_python_import

3. The package is already installed and running.

> [!NOTE]
> You can always update to the newest version by running `git pull`
> from inside of that `copy_python_import` directory.

### From a download

1. Open the [releases](https://github.com/odiroot/copy_python_import/releases) page.
2. Download _Source code (zip)_ for the newest release.
3. Unpack the ZIP archive.
4. Copy the `copy_python_import-master` directory to your Sublime Text package directory.
5. All done!

# Usage

Navigate with your keyboard or mouse to move the cursor to a symbol you want
to import. 

Then either:

1. Open the _Command Palette_ and search for **Copy Python Import**.
2. Right click to open the context menu and click **Copy Python Import**.
3. Use a custom key binding (see [Configuration](#configuration)).

# Configuration

To comply with Sublime Text package guidelines, default key bindings are provided but **disabled** by default.

To enable or customize them:

1. Go to **Preferences** → **Package Settings** → **Copy Python Import** → **Key Bindings**.
2. Copy the suggested binding from the left pane (the default file) to the right pane (your user settings).
3. Adjust the `keys` if desired and save.

### Example Key Binding

```json
[
    { "keys": ["ctrl+alt+i"], "command": "copy_python_import" }
]
```

# Disclaimer

Forked from [pokidovea/copy_python_path](https://github.com/pokidovea/copy_python_path)