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

First make sure you have uv installed and updated:

uv self update

Furthermore if you haven't already created a project 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

Template

If you want a simple minimal setup process then just use the effectual-template

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 (multiple output bundles)
  • Bundle python version shebang and bytecode compilation
  • Plugin and loader system (like rollup and webpack)

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.7.8.tar.gz (33.9 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.7.8-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.8.tar.gz
Algorithm Hash digest
SHA256 9763e92ddd57083431ac35d248b37494dbe32943eaab25b54d392b91e4674a8e
MD5 7f24d2879c0a6f757449e5a2047cf542
BLAKE2b-256 3a58e45d2276b12c5b55b387741d107a571751b827cc9a95100fbdb4b0eb6b80

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ff7464e5b6dd8f1266c5202a08479d9c9d562e9a96026b47d5b370d60104bee2
MD5 359e3982e03c69dc4e51a0b2da3dca33
BLAKE2b-256 394883f9c66f521227dbea00903b8d8d0aa2100d7ea6800915fe837714d199cd

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