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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for effectual-0.5.6.tar.gz
Algorithm Hash digest
SHA256 2381755420bf58fbcf82a254e74729f366cda017c6cde45070cfb1b25994b2e0
MD5 421f53cc95eab826d73c0324e378411e
BLAKE2b-256 4e21da1122fd2b9ee79e77da7f8b35080f5ee59047adf7a64760124c6572dc64

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for effectual-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 dca99393dbd9218140dee4465b364d19ea05b3a85dbde012b03303f46bdfcce5
MD5 f9fff37def648769bc719ebbd9ebb424
BLAKE2b-256 b3ced85e25127b79ba7f1a382f0d3fd28f904ab54aa8ae892d9ea65ed0faa95a

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