https://github.com/rishabh672003/pyfix-imports

Simple python program to fix your missing imports
https://github.com/rishabh672003/pyfix-imports

devtool python

Last synced: 3 months ago
JSON representation

Simple python program to fix your missing imports

• Host: GitHub
• URL: https://github.com/rishabh672003/pyfix-imports
• Owner: Rishabh672003
• License: gpl-3.0
• Created: 2024-06-23T17:34:45.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T14:50:24.000Z (5 months ago)
• Last Synced: 2024-08-10T15:59:38.656Z (5 months ago)
• Topics: devtool, python
• Language: Python
• Homepage: https://pypi.org/project/pyfix-imports/
• Size: 114 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PyFix-Imports

WIP Python library which fixes missing imports, It automatically fixes missing imports by importing them

I mostly wrote this to learn more about python, and wanted to make something with.

https://github.com/Rishabh672003/fix-imports/assets/53911515/941f0b59-a4d0-498f-89a4-0104a2eae92f

## Installation

Just run `pip install pyfix-imports`

## Usage

```sh

pyfix-imports  # returns the fixed code to the stdout

```

```sh

pyfix-imports -f  # Writes the fixed code to the file

```

```sh

pyfix-imports -c   # uses the config file

```

I recommend after running the program use [isort](https://pycqa.github.io/isort/) or [ruff](https://github.com/astral-sh/ruff) to sort the imports.

## Configuration

The default configuration file should be placed in `$XDG_CONFIG_HOME/pyfix-imports/config.toml`

or you can place your config file anywhere and just provide the path to the command `fix-imports -c `

the structure should be like this, don't forget to include [config] on the top

```toml

[config]

"tf" = "import tensorflow as tf"

"plt" = "import matplotlib.pyplot as plt"

"isprime" = "from sympy import isprime"

```

## How I use it

As they say necessity is the mother of invention, also python language server like, pyright and pylsp don't do that good

of a job, that gave me the motivation to made this. I use this with the conjunction of black and isort within my neovim

with [conform.nvim](https://github.com/stevearc/conform.nvim) you can also use it just put this in your conform setup

```lua

require("conform").setup({

    formatters_by_ft = {

    python = { "pyfix_imports", "ruff_fix", "ruff_organize_imports", "ruff_format", },

    formatters = {

        pyfix_imports = {

            command = "pyfix-imports",

            args = { "$FILENAME" },

            cwd = require("conform.util").root_file({ "requirements.txt", "pyproject.toml" }),

        },

    }

})

```

## References

I took many projects for reference/code

- [autoimport](https://lyz-code.github.io/autoimport/) I could have just used this, but I wanted to make something so

  took it as a reference and made this. I didn't took that much code from it, but yes as someone who has never made a

  decent size python project it was really helpful

- [autoflake](https://pypi.org/project/autoflake/) I wanted to use pyflakes to get the errors in code, and this one had

  great implementation of pyflake api.

- [pyflakes](https://pypi.org/project/pyflakes/) Used this to get all the errors for undefined names.

- [click](https://click.palletsprojects.com/en/8.1.x/) Used this to make the command-line interface

- [pdm](https://github.com/pdm-project/pdm) Used this to structure and manage dependency for the project

- [xdg-base-dirs](https://github.com/srstevenson/xdg-base-dirs) Used this to get the config file