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

Uploaded Python 3

File details

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

File metadata

  • Download URL: effectual-0.7.4.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.4.tar.gz
Algorithm Hash digest
SHA256 6e27fc5472f2eb5d4cac008b0dc7d81c9c9e466c6ee12d50620e8636a2c79051
MD5 e4ee49d91ef3c5deddaba8e7fea326e5
BLAKE2b-256 46247d0188114d418b219520947ebcb039cf57536415effb82e8a1875c4e3f7d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fb98c325990de9a679d3ff22d0fdaadaef5d7899989ffa322d611ab66646765a
MD5 71c2a969be4172bd15db8da98b39305a
BLAKE2b-256 20646eb2ca9c9ca3a4aa7fe6442b92db33f0f7d6c13204cace593b1df44c7c2e

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