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 (multiple output bundles)
  • Bundle python version shebang and bytecode compilation
  • Plugin and loader system (like rollup and webpack)

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.9.tar.gz (47.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.9-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.9.tar.gz
Algorithm Hash digest
SHA256 47c8173a3ce43138e896dbae822bbbd483ff9c4aff55044c10109f228e6aa0a1
MD5 5dbb3d919fbf860f90da6ae39e90320b
BLAKE2b-256 f5b2977b6cd413fc80b5d17216179e4e7e3302db68451daea7e3c3a0f2796694

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 86cb68e197548e0a07990f8a2f83e2af4e0c2b1dfb4752013503d4b288c51736
MD5 2d2d15e5a8944bc92ad4ec4f929d1c98
BLAKE2b-256 acf5c0563368fe81e2ad67672050cc489a53ff27699c8df777394ded11563988

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