File size: 3,242 Bytes
69ed2c6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | # This ensures that we can call `make <target>` even if `<target>` exists as a file or
# directory.
.PHONY: notebook docs
# Exports all variables defined in the makefile available to scripts
.EXPORT_ALL_VARIABLES:
install-poetry:
@echo "Installing poetry..."
@curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
uninstall-poetry:
@echo "Uninstalling poetry..."
@curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 - --uninstall
install:
@echo "Installing..."
@if [ "$(shell which poetry)" = "" ]; then \
make install-poetry; \
fi
@if [ "$(shell which gpg)" = "" ]; then \
echo "GPG not installed, so an error will occur. Install GPG on MacOS with "\
"`brew install gnupg` or on Ubuntu with `apt install gnupg` and run "\
"`make install` again."; \
fi
@poetry env use python3
@poetry run python3 -m src.scripts.fix_dot_env_file
@git init
@. .env; \
git config --local user.name "$${GIT_NAME}"; \
git config --local user.email "$${GIT_EMAIL}"
@. .env; \
if [ "$${GPG_KEY_ID}" = "" ]; then \
echo "No GPG key ID specified. Skipping GPG signing."; \
git config --local commit.gpgsign false; \
else \
echo "Signing with GPG key ID $${GPG_KEY_ID}..."; \
git config --local commit.gpgsign true; \
git config --local user.signingkey "$${GPG_KEY_ID}"; \
fi
@poetry install
@poetry run pre-commit install
remove-env:
@poetry env remove python3
@echo "Removed virtual environment."
docs:
@poetry run pdoc --docformat google -o docs src/mumin
@echo "Saved documentation."
view-docs:
@echo "Viewing API documentation..."
@open docs/mumin.html
clean:
@find . -type f -name "*.py[co]" -delete
@find . -type d -name "__pycache__" -delete
@rm -rf .pytest_cache
@echo "Cleaned repository."
test:
@pytest && readme-cov
tree:
@tree -a \
-I .git \
-I .mypy_cache . \
-I .env \
-I .venv \
-I poetry.lock \
-I .ipynb_checkpoints \
-I dist \
-I .gitkeep \
-I docs \
-I .pytest_cache
bump-major:
@poetry run python -m src.scripts.versioning --major
@echo "Bumped major version."
bump-minor:
@poetry run python -m src.scripts.versioning --minor
@echo "Bumped minor version."
bump-patch:
@poetry run python -m src.scripts.versioning --patch
@echo "Bumped patch version."
publish:
@. .env; \
printf "Preparing to publish to PyPI. Have you ensured to change the package version with 'make bump-X' for 'X' being 'major', 'minor' or 'patch', as well as run unit tests with 'make test'? [y/n] : "; \
read -r answer; \
if [ "$${answer}" = "y" ]; then \
if [ "$${PYPI_API_TOKEN}" = "" ]; then \
echo "No PyPI API token specified in the '.env' file, so cannot publish."; \
else \
echo "Publishing to PyPI..."; \
poetry publish --build --username "__token__" --password "$${PYPI_API_TOKEN}"; \
echo "Published!"; \
fi \
else \
echo "Publishing aborted."; \
fi
compile-small:
@poetry run python -m src.scripts.compile_mumin small
compile-medium:
@poetry run python -m src.scripts.compile_mumin medium
compile-large:
@poetry run python -m src.scripts.compile_mumin large
compile-test:
@poetry run python -m src.scripts.compile_mumin test
|