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
  • 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.6.tar.gz (33.2 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.6-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.6.tar.gz
Algorithm Hash digest
SHA256 79c3c656b2d59a1ff3a9d2c08a11ad2568fdfc9c7e85313a1c16cf375c9aad91
MD5 2c56b4d2fc4b0dadb98637b24b4fd786
BLAKE2b-256 f660a0db909e02671d7831d083e2709cf7792c82e35ff4392fd0fa9d1c2fa20e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 57820c688e382bb0cbbfe5e08f43855e997abff2572463b276980a86ab956c1c
MD5 185333aa77c659301eaae0b6cba30af8
BLAKE2b-256 e84d8473b0158799028f7b806b55334401c440f4d92f648a6271dd27cef37aae

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