easydev
- documentation:
- contributions:
Please join https://github.com/cokelaer/easydev
- source:
Please use https://github.com/cokelaer/easydev
- issues:
Please use https://github.com/cokelaer/easydev/issues
- Python version supported:
3.9, 3.10, 3.11, 3.12, 3.13, 3.14
Overview
The easydev package provides miscellaneous utility functions and classes that are repeatedly useful during the development of Python packages. The goal is to help developers speed up their work by providing ready-to-use tools for common tasks such as parameter validation, logging, progress bars, configuration files, multiprocessing, and more.
It has been used as an incubator for other packages (e.g., colormap) and is used in projects such as bioservices, sequana, and GDSCTools.
Installation
Install the latest release from PyPI:
pip install easydev
Features
Parameter validation – check_param_in_list, check_range
Dictionary utilities – swapdict, AttrDict (access dict keys as attributes, supports nested dicts)
Logging – coloured logging via Logging class
Progress bar – Progress works in Python, IPython, and Jupyter notebooks
Timer – measure elapsed time with the Timer context manager
Profiling – do_profile decorator using line_profiler
Configuration files – CustomConfig and DynamicConfigParser for INI-style config management
Shell commands – shellcmd and execute wrappers around subprocess/pexpect
File utilities – touch, mkdirs, md5
Multiprocessing – MultiProcessing class for easy parallel job execution
Codecs – to_list, list2string and other conversion helpers
URL utilities – isurl_reachable and related helpers
Sphinx integration – bundled Sphinx theme and copybutton extension
Quick Start
Parameter validation:
from easydev import check_param_in_list, check_range
check_param_in_list("on", ["on", "off"]) # passes silently
check_range(0.5, 0, 1) # passes silently
AttrDict – access nested dictionary keys as attributes:
from easydev import AttrDict
d = AttrDict(**{"server": {"host": "localhost", "port": 8080}})
print(d.server.host) # localhost
d.server.port = 9090
Coloured logging:
from easydev import Logging
logger = Logging("myapp", "WARNING")
logger.warning("something went wrong")
logger.debug("not shown at WARNING level")
logger.level = "DEBUG"
logger.debug("now it is shown")
Progress bar:
from easydev import Progress
pb = Progress(100)
for i in range(100):
# do work here
pb.animate(i + 1)
Timer:
from easydev import Timer
import time
times = []
with Timer(times):
time.sleep(0.1)
print(f"elapsed: {times[0]:.2f}s")
Multiprocessing:
from easydev.multicore import MultiProcessing
def square(n):
return n * n
t = MultiProcessing(maxcpu=4)
for i in range(10):
t.add_job(square, i)
t.run()
print(t.results)
Moving away from easydev
easydev dates from a time when Python lacked many small conveniences. Most of its tools now have a standard-library or well-maintained third-party replacement, and new projects should not depend on easydev. The full module-by-module guide is in the documentation (doc/source/migration.rst). Main replacements:
easydev |
Use instead |
|---|---|
CustomConfig, AppDirs |
platformdirs |
DynamicConfigParser |
configparser |
AttrDict |
types.SimpleNamespace / dataclasses |
Logging |
logging (+ colorlog) |
Progress |
tqdm |
MultiProcessing |
concurrent.futures.ProcessPoolExecutor |
shellcmd, execute |
subprocess.run |
mkdirs, touch, get_home |
pathlib / os.makedirs(exist_ok=True) |
cmd_exists |
shutil.which |
md5 |
hashlib.file_digest (Python 3.11+) |
browse |
webbrowser.open |
get_dependencies |
importlib.metadata.requires |
get_share_file |
importlib.resources.files |
For example, replacing CustomConfig:
# before
from easydev import CustomConfig
config_dir = CustomConfig("myapp").user_config_dir
# after
from pathlib import Path
from platformdirs import user_config_dir
config_dir = Path(user_config_dir("myapp"))
config_dir.mkdir(parents=True, exist_ok=True)
Changelog
Version |
Description |
|---|---|
0.15.0 |
|
0.13.3 |
|
0.13.2 |
|
0.13.1 |
|
0.13.0 |
|
0.12.2 |
|
1 maintainer
Metadata
1 maintainer
Release files for easydev 0.15.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| easydev-0.15.0.tar.gz | 38.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| easydev-0.15.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 97.7 kB
Release files / easydev-0.15.0.tar.gz
| Download URL | easydev-0.15.0.tar.gz |
|---|---|
| Size | 38.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
40eed6bfa254bab47fdead8a444733f1aeac4dc158fc0670532a63d821045b79
|
|
BLAKE2b-256 checksum How to use checksums |
178d1506e25254a1cca3508bc45f09f8f36c1f37e3bdd358075d23df1c4b7b46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.14.5-100.fc40.x86_64
|
Release files / easydev-0.15.0-py3-none-any.whl
| Download URL | easydev-0.15.0-py3-none-any.whl |
|---|---|
| Size | 58.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c26d8e39c8cda8ea504c391b45c9c7a3a7abc834a4dfecd2faebd17cb5b6cb43
|
|
BLAKE2b-256 checksum How to use checksums |
4339caefc1fbf5a80a03093d0e9dbe42cac5179b516cc8a89e7016e0913bd161
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.4 CPython/3.11.15 Linux/6.14.5-100.fc40.x86_64
|
