Skip to main content

effectual

Python MIT License Ruff

/ɪˈfek.tʃu.əl/ meaning effective and successful

Why?

Sometimes you want a single portable Python executable file without having to make a platform specific executable (with tools such as pyinstaller or nuitka) or a .pyz file without dependencies! 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
  • The output bundle needs to include packages that aren't mostly written in python (such as packages written with maturin)

Is this production ready

No

Setup

Template

If you want minimal setup then you can use the effectual-template

DIY

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

[tool.effectual]

sourceDirectory = "./src/"
outputDirectory =  "./dist/"
outputFileName = "bundle.pyz"
minification = true
compressionLevel = 5

Note you must have a __main__.py entrypoint in the source directory 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
  • Adding inline script metadata to all source files by default
  • Plugin and loader system (like rollup and webpack)
  • Python based config file for more granular builds rather then using the pyproject.toml

Contributions

All contributions are welcome, I'm not the best in the world at project management but if you think you can add a feature or improve anything please send over a pull request!

Building from source

Requirements

To build the project from source you need two tools:

  1. uv
  2. TaskFile

Process

  1. CD to project directory and run:

     task setup
    
  2. Then to build a distributable tar.gz and wheel:

     task build
    

Metadata

Release files for effectual 0.8.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for effectual 0.8.18
File Size Uploaded Provenance Actions
effectual-0.8.18.tar.gz 9.7 kB Without provenance Details for effectual-0.8.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for effectual 0.8.18
File Interpreter ABI Platform Actions
effectual-0.8.18-py3-none-any.whl Python 3 none any Details for effectual-0.8.18-py3-none-any.whl

Total release size: 19.4 kB

Release files / effectual-0.8.18.tar.gz

Download URL effectual-0.8.18.tar.gz
Size 9.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8fe3def7280902e1b09cd509858ec02a5cd0167ec717ab601a9b3b6f932cf252
BLAKE2b-256 checksum
How to use checksums
685f46d0474da2b2b27b3463130422a869ceaf638c45f133ce6c5e3c57b46104
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.1 {"ci":null,"cpu":"AMD64","implementation":{"name":"CPython","version":"3.11.10"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.15 3 Sep 2024","python":"3.11.10","system":{"name":"Windows","release":"10"}} HTTPX2/2.16.0

Release files / effectual-0.8.18-py3-none-any.whl

Download URL effectual-0.8.18-py3-none-any.whl
Size 9.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
018811c11804b3fbd842fcf5a10d6bbfa250de7c437feaa66f3abadeb3cac8ef
BLAKE2b-256 checksum
How to use checksums
53b984245cba9b74c52faf68f4b6616423be00dd33ee75bb44b6942d43301cbb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.1 {"ci":null,"cpu":"AMD64","implementation":{"name":"CPython","version":"3.11.10"},"installer":{"name":"hatch","version":"1.18.1"},"openssl_version":"OpenSSL 3.0.15 3 Sep 2024","python":"3.11.10","system":{"name":"Windows","release":"10"}} HTTPX2/2.16.0

Security for effectual 0.8.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.8.18 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page