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.1.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.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: effectual-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 9e30566578ea7916605eab83e1a32711e100bb1a0ec2d4c3645649615d14db57
MD5 e6d877e267912ea1920332a0811a3b41
BLAKE2b-256 a55ae775ddd30d1fe84d3e586b156d0e7bd05a57679e8a3b1b6eb84a7d6aa8fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: effectual-0.7.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe6eb9d5a4ba6e43ef90511124583c0ba53271934da278fe7b5fe46914de9f25
MD5 ac15440241b8a9241550f72bf9996685
BLAKE2b-256 d6e40375ed18b1a3931eed598781f3507fb3a200845a475e148809fe84be8c47

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