Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

utilities

A home for finished, standalone scripts that actually do something.

Each subfolder is a self-contained utility with its own README. These are not experiments (those live in the sandbox); they are tools that are complete and usable as-is.

Contents

Utility Description
password_generator Interactive generator for compliant, cryptographically secure passwords with selectable character types, cross-class exclusions, strength estimates, and batch generation.

Installing (optional, lets you import the tools from anywhere)

By default you can use a tool only from this utilities folder (so Python can find it). To import the packages from any script, anywhere, install the collection once in editable mode. From this folder:

pip install -e .

After that, import password_generator works from any folder and any script, with no path setup. "Editable" means it points at these files in place, so your edits take effect immediately without reinstalling.

Each tool folder that is a Python package becomes its own importable top-level package (e.g. import password_generator). Adding a new tool later needs no changes to pyproject.toml.

Adding a new tool

This whole folder is one installable distribution named utilities. Every tool folder inside it is bundled into that single distribution, so you do not create a separate install (or a separate pyproject.toml) per tool.

To add a tool:

  1. Drop its folder into utilities/, with an __init__.py so it's a package (e.g. utilities/my_tool/__init__.py).
  2. Re-run the same editable install once to register it:
    pip install -e .
  3. Import it by its folder name: import my_tool.

Notes:

  • There is always exactly one utilities.egg-info folder, no matter how many tools you add. You never get one per tool.
  • Do not create a second pyproject.toml that reuses the name utilities. Two projects with the same distribution name collide; pip treats the second as overwriting the first.
  • Only make a tool its own separate distribution (its own subfolder pyproject.toml with a unique name) if you genuinely need per-tool versions or dependencies. For this collection, the single install is simpler.

Using a tool from your own script

See password_generator/example_usage.py for a reference showing the three ways to use password_generator from your own code: calling the generator functions directly, launching its interactive app, and running its tests.

About

re-usable, production ready utility scripts

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages