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 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
  • The output bundle needs to include packages that aren't mostly written in python

Setup

Template

If you want a simple minimal setup process then just 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 and configure to your heart's desire

[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
  • Cross platform compatibility (multiple output bundles)
  • Bundling python version shebang and bytecode compilation
  • 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 the project 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.16

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.16
File Size Uploaded Provenance Actions
effectual-0.8.16.tar.gz 9.4 kB Without provenance Details for effectual-0.8.16.tar.gz

Built distribution (wheel)

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

Total release size: 18.9 kB

Release files / effectual-0.8.16.tar.gz

Download URL effectual-0.8.16.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f1fafacc8f3f062a28e49a3430fa1b5e886ac6f2769b5057ae6f453fb524d7ab
BLAKE2b-256 checksum
How to use checksums
65a4c43f44c4eb552dfa3c5dd9d0b42bafb4b0e8e6f468f443de5c5761a67486
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.16-py3-none-any.whl

Download URL effectual-0.8.16-py3-none-any.whl
Size 9.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b37004a5f7f4699fb7f2c99f0391e62c3073e8e34b0e5e1aabcb3d3f5f5c84f0
BLAKE2b-256 checksum
How to use checksums
449bc08529fddb75fbd9a8fdeee2aaedb47fa50d8b3b5dfefa53361876ba8982
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.16

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.16 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