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.7.2.tar.gz (33.0 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.2-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.2.tar.gz
Algorithm Hash digest
SHA256 017e85727246916d705802470b65dfb06cd9b16f2f32ca307c0ca49de4953b90
MD5 e07067d44402218cf6fa55ba80f7d6f4
BLAKE2b-256 97af2aa5cd2a9138fd950ec4a3516924532ed77d7bd45c2a2b342687b23e3297

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 599fc2904a7a77f9fc00ab586eddb991428d7ea86f8c2469016e7e5d12578e95
MD5 42dc24a5f8022588c30b63171cba2187
BLAKE2b-256 42a0b8e6fd10b07ed3e097dfe76334d2cd3be17abcacbf5222a1ebe8c7e6979f

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