Skip to main content

A python package/script bundler

Project description

effectual

/ɪˈfek.tʃu.əl/ meaning effective and successful

Why?

Sometimes you want a single portable python file without having to make a platform specific executable or a dependency-less .pyz! Basically me trying to make Vite for python (badly) :(

When not to use this

  • The python package requires access to specific files like CustomTkinter and Pillow
  • Incredibly version specific code, for example something that won't run on a slightly different python version or operating system

Setup

If you haven't already, run:

uv init

Then to install effectual run:

uv add effectual --dev

Finally add the following lines to your pyproject.toml and configure to your hearts desire

[tool.effectual]

sourceDirectory = "./src/"
outputDirectory =  "./dist/"
outputFileName = "bundle.pyz"
minification = true
compressionLevel=5

Note you must have a __main__.py entrypoint for this to work

Bundling

Development

To bundle in dev mode use:

uv run efec dev

This is like what esBuild does for vite

Production

To build a distributable .pyz file run:

uv run efec dist

This is like what what Rollup does for vite

To be added

  • Treeshaking
  • Rewriting some time critical parts in Rust 🚀🦀
  • Cross platform compatibility
  • Plugin and loader system

Contributions

All contributions are welcome, I'm not the best in the world at project management but if you think you can add or improve anything please send over a pull request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

effectual-0.5.7.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

effectual-0.5.7-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file effectual-0.5.7.tar.gz.

File metadata

  • Download URL: effectual-0.5.7.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.6

File hashes

Hashes for effectual-0.5.7.tar.gz
Algorithm Hash digest
SHA256 bb4e66fcc02c39e277b5cb9d5bc90f7af0a1967783a5a74f9b2af16b05ae0831
MD5 cc962ebd57012234c7fdeaa2d97cbfa0
BLAKE2b-256 f603f4ca3755d26c11ce5097ff39b93a75c6575dca9bd6dfb5559b3dd35ddcdc

See more details on using hashes here.

File details

Details for the file effectual-0.5.7-py3-none-any.whl.

File metadata

  • Download URL: effectual-0.5.7-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.6

File hashes

Hashes for effectual-0.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ca107a3278dc6ed1a09b9cdf51aa1ec35993ed984fd10022fc33e31b0fe0a8c4
MD5 0ebca22e3b3488a5f25ba9d758a1d88f
BLAKE2b-256 c694dc15e0c57444027215c00441f4cc0aeadef97a8287334d5bd1c8c87ff9e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page