pydevtips 0.0.4

Installation

This “dummy” package can be installed with pip:

pip install pydevtips

Or from source. Firstly, Poetry must be installed: https://python-poetry.org/docs/#installation

# -- recommend using pipx
pipx install poetry

# -- or with official installer
# curl -sSL https://install.python-poetry.org | python3 -

# I recommend creating virtual environment in the project folder
poetry config virtualenvs.in-project true

Then the following commands can be run:

# get source code
git clone git@github.com:ebezzam/python-dev-tips.git
cd python-dev-tips

# create new environment, press enter to accept
# -- important to set python version, otherwise `python` executable may not exist
# -- (would be `python3` instead)
conda create -n project_env python=3.11

# view available environments
conda info --envs

# activate environment
conda activate project_env

# install package locally
(project_env) poetry install --with dev

# install pre-commit hooks
(project_env) pre-commit install

# run tests
(project_env) pytest

# deactivate environment
(project_env) conda deactivate

Or without conda and just Poetry:

# get source code
git clone git@github.com:ebezzam/python-dev-tips.git
cd python-dev-tips

# install package locally
poetry install --with dev
# -- `poetry env info` to see where the virtual environment is located

# install pre-commit hooks
poetry run pre-commit install

# run tests
poetry run pytest

## NOTE that Python related commands need to be run
## with `poetry run` or by activating the virtual environment
## https://python-poetry.org/docs/basic-usage/#activating-the-virtual-environment

Examples

Examples can be found in the examples and notebooks folders. Scripts from the examples folder should be run from the root of the repository, e.g.:

python examples/real_convolve.py

Parameter setting is done with hydra. More on that in the Reproducible examples section of the documentation.

TODO

• switch to ruff for code formatting: https://docs.astral.sh/ruff/

• numba: https://numba.pydata.org/

• picking a license

• change documentation links to main branch

• github page

• point out features in scripts: object-oriented, asserts, tqdm, type hints

• manifest file to not include file in package

• GitHub actions for releasing to PyPi when changes to version

• pytorch compatible

• Cython / C++