fupi 0.6rc0

A brute-force shortcut to fix python import hell. Acronym, standing for, um, Fix Up Python Imports. Sure, let's go with that.

fupi

A brute-force shortcut to fix python import hell. Acronym standing for... um, Fixing-Up Python Imports.

Sure, let's go with that.

Usage

Simply import fupi in your project:

import fupi

This automatically adds relevant directories (like src and test) to your Python path, making imports work seamlessly across your project structure.

Configuration

No configuration is needed if you use the defaults:

• Add src and test folders and subfolders,
• Skip folders setup, venv*, and *egg*.

.ENV File Config

To use different / more folder names, simply add the following to an existing .env file, or create a new *.env or fupi.env file:

FUPI_ADD_DIRS="src,test"
FUPI_SKIP_DIRS="setup,venv*,*egg*"

The FUPI_ADD_DIRS will be string-matched against folders in your project, and on exact match, will include that folder and all subfolders into your sys.path.

The FUPI_SKIP_DIRS is a collection of regex patterns to skip, with string begin and end tags added (^value$). Thus you can simply add a list of folder names, or use basic wildcard * characters. If you want to get crazy with regex, be my guest - but understand the value will be wrapped (^value$).

The FUPI_SKIP_DIRS will also always append patters to disqualify any path starting with a period('.') or an underscore('_') (i.e., '\.*' and '\_*'), which should catch most common skipped folders like .git, __pycache__, etc.

Environment Variable Config

Alternatively, you can add the above to os.envars before you import fupi. Note, this process does NOT use dotenv, which would also load into os.envars, although the behavior is similar, just restricted to only FUPI_* configs. Similar to the .env approach above, simply add a comma-delimited list of all folder names / regex patterns.

Manual Setting

You can also manually call the functions in the fupi libary with whatever settings you'd like. To take advantage of this option, you'll have to escape the default behavior of running all logic on import fupi, automatically.

To escape the auto-run, add a single .env or envvar as per below:

FUPI_ADD_DIRS="disable"

Then you can configure manually, with:

from fupi import fupi
fupi.add_dirs_and_children_to_syspath(
    add_dirs=['my','app','folders'], 
    skip_dirs=['not','*these*'])

Finally, if you want to roll-back to a previous state, the sys.path contents is logged in the object sys_path_history which captures the pre-execution snapshot at index[0], and subsequent snapshots every time a change is made. This would allow you to 'roll-back' to a pre-exexution state by simply:

sys.path = sys_path_history[0]['sys.path set 0']