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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.0.tar.gz
Algorithm Hash digest
SHA256 f4b1ed0aaa919b1577d6c012d95389f558086d79e1458a98b2377c42ece694df
MD5 003ce55c398af60cfe57021ee7bbbfa9
BLAKE2b-256 7ff8ecf59173acd2364909d5efb37d3a1e2f1eda7295a151a2b29afdd74dbd75

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61c8256cfeb9c0ddb8ca43135fc779d52581415da294ffb2706055b6de313676
MD5 389b68b9e1a9f181732ef84c1c5e3114
BLAKE2b-256 b3b2c2df3c0232b76cf926a9820c4a4a1b85365aafe28b573d6480f9df9aae58

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