These are notes for developers working on osxphotos. They're mostly to help me remember how to do things in this repo but will be useful to anyone who wants to contribute to osxphotos.
- Clone the repo:
git clone git@github.com:RhetTbull/osxphotos.git - Create a virtual environment and activate it:
python3 -m venv venvthensource venv/bin/activate. I use pyenv with pyenv-virtualenv to manage my virtual environments - Install the requirements:
python3 -m pip install -r requirements.txt - Install the development requirements:
python3 -m pip install -r dev_requirements.txt - Install osxphotos:
python3 -m pip install -e .
- Run all tests:
pytest
See the test README.md for more information on running tests.
- Run
./build.shto run the build script.
cogapp is used to update the README.md and other files. cog will be called from the build script as needed.