effectual
/ɪˈ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:
Process
-
CD to project directory and run:
task setup -
Then to build a distributable tar.gz and wheel:
task build
Metadata
Release files for effectual 0.8.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| effectual-0.8.17.tar.gz | 9.6 kB | Without provenance | Details for effectual-0.8.17.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| effectual-0.8.17-py3-none-any.whl | Python 3 | none | any | Details for effectual-0.8.17-py3-none-any.whl |
Total release size: 19.2 kB
Release files / effectual-0.8.17.tar.gz
| Download URL | effectual-0.8.17.tar.gz |
|---|---|
| Size | 9.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
44c5b51b9764f07ac936c25856f3d526773ad8377417516b70c4ac0af6ec9e93
|
|
BLAKE2b-256 checksum How to use checksums |
3c2bf18425ef617dd211d78c8734858ed83672da1169d206f38555a68b8611f0
|
| 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.17-py3-none-any.whl
| Download URL | effectual-0.8.17-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
84501c42fdf6a24d5fb1cab189709248d35aa583dd15e18e2f40cf1238ed42b1
|
|
BLAKE2b-256 checksum How to use checksums |
77dd3327127909d5672903cf1a6d5536d1b735b7af35c9b2b61ae5c8719e56b6
|
| 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.17
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.