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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.7.tar.gz
Algorithm Hash digest
SHA256 4794448da8e0c330d6c960decf1f4e06d75d3c345f71ba3c3e0552332c644269
MD5 3eb72b1301728c486fad982821258004
BLAKE2b-256 807b29d3a73e79b63536cc76ca88490427fb60c4abe499e25c8723fed1f0343a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: effectual-0.7.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ef6a571c3ecc38c980fe2e5f7d1084fb2b714cb697b87db1337974b6cf50327f
MD5 9c5b7c59b7a7cc8c94c57a80a3868081
BLAKE2b-256 c03d7d11252fca5f0cf6b4c8e1ee32e08379f2b9cd6eeb925e701d54ffeae046

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