child-diary-photo-export

Tool to export photos from the child diary app.

We are using Python 3.10 and Poetry as the Python dependency management tool. All the currently required dependencies are in the pyproject.toml file.

To set up the project:

• If you haven't already, install Poetry by running: curl -sSL https://install.python-poetry.org | python3 -
• After that, you can create the virtual environment with poetry install
• Add the versioning plugin to Poetry running poetry self add "poetry-dynamic-versioning[plugin]"
• Configure PyCharm to format docstrings with numpy style.

Guidelines

To make things easier, we're also using Python's ruff tool to deal with code formatting, as the code linter, and to sort imports.

mypy is used for type hinting.

You can run make mypy for example to for type checking, or make ruff to run the linter and format the code for you.

When developing code for this repository, please be sure you install the pre-commit hooks:

cd path/to/repo
pre-commit install

Afterwards, whenever you try to commit changes, the pre-commit hooks will run and inform you of possible warnings/errors that must be fixed.

Utilities

Profiling with cProfile and snakeviz

# using cProfile
python -m cProfile -o foo.stats foo.py

sudo pip install snakeviz
snakeviz foo.pstats

# The visualization is opened in the browser in: http://127.0.0.1:8080

Profiling with line_profiles

Decorate the functions to profile with @profile:

@profile
def slow_function(a, b, c):
    ...

run the kernprof command on the script:

kernprof -l script_to_profile.py
python -m line_profiler script_to_profile.py.lprof