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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.5.tar.gz
Algorithm Hash digest
SHA256 95b4bfe3a19f62c4536c3dde07d978288e41644e895284d5314a662b79057cf1
MD5 c11003824a75d64669d4a9ab01102de2
BLAKE2b-256 a40311c164cc653d865752931aa1f6f90b5dcca6c1b199b7a394492678dc506a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 43d8a7691ab9de9d0108b36b87ab7ed435d3cca629456c21b7f786845680c9aa
MD5 9814f486bdf46247f7e6b91ad707ab7e
BLAKE2b-256 008739f06000e8677b3be5ad75743b602aa2b03f11724ccddfa69cd3742dc5d8

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