blob: bd57d457860b05ab0b2a2622df172c6c5d2c05d3 (
plain)
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
|
SHELL := /bin/bash
FATCAT_BULK_EXPORT_ITEM := fatcat_bulk_exports_2020-08-05
PY_FILES := $(shell find fuzzycat -name '*.py')
.PHONY: help
help: ## Print info about all commands
@echo "Commands:"
@echo
@grep -E '^[/.a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[01;32m%-40s\033[0m %s\n", $$1, $$2}'
.PHONY: deps
deps: ## Install dependencies from setup.py into pipenv
pipenv install --dev --deploy
.PHONY: fmt
fmt: ## Apply import sorting and yapf source formatting on all files
isort --atomic fuzzycat/*
yapf -p -i -r fuzzycat/*
yapf -p -i -r tests
.PHONY: dist
dist: ## Create source distribution and wheel
python setup.py sdist bdist_wheel
# https://engineering.fb.com/2018/07/13/data-infrastructure/xars-a-more-efficient-open-source-system-for-self-contained-executables/
#
# Required a build from source https://github.com/vasi/squashfuse, to get the squashfuse_ll (low level) executable.
.PHONY: xar
xar: ## Create a XAR standalone package (https://github.com/facebookincubator/xar, https://github.com/vasi/squashfuse)
python setup.py bdist_xar
.PHONY: cov
cov: ## Run coverage report
pytest --cov=fuzzycat fuzzycat/*.py tests/ # --cov-report annotate:cov_annotate --cov-report html
.PHONY: test
test: ## Run coverage report
pytest -o log_cli=true -s -vvv fuzzycat/*.py tests/*.py
.PHONY: lint
lint: $(PY_FILES) ## Run pylint
pylint fuzzycat
.PHONY: mypy
mypy: ## Run mypy checks
mypy --strict $$(find fuzzycat -name "*py")
.PHONY: clean
clean: ## Clean all artifacts
rm -rf build
rm -rf dist
rm -rf fuzzycat.egg-info/
rm -rf .pytest_cache/
rm -rf .coverage
rm -rf htmlcov/
rm -rf cov_annotate/
rm -rf .mypy_cache/
find . -name "__pycache__" -type d -exec rm -rf {} \;
# Upload requires https://github.com/pypa/twine and some configuration.
.PHONY: upload
upload: dist ## Upload to pypi
# https://pypi.org/account/register/
# $ cat ~/.pypirc
# [pypi]
# username:abc
# password:secret
#
# For internal repositories, name them in ~/.pypirc (e.g. "internal"), then
# run: make upload TWINE_OPTS="-r internal" to upload to hosted pypi
# repository.
#
# For automatic package deployments, also see: .gitlab-ci.yml.
twine upload $(TWINE_OPTS) dist/*
# ==== data related targets
#
# data/release_export_expanded.json.gz: ## Download release export
# mkdir -p data
# wget -c https://archive.org/download/$(FATCAT_BULK_EXPORT_ITEM)/release_export_expanded.json.gz -O $@
#
# data/container_export.json.gz: ## Download container export
# mkdir -p data
# wget -c https://archive.org/download/$(FATCAT_BULK_EXPORT_ITEM)/container_export.json.gz -O $@
#
# data/name_to_issn.json: data/issn.ndj ## Create a name to ISSN mapping (needs an ISSN JSON dump)
# fuzzycat-issn --make-mapping $^ > $@
#
# names.db: data/issn.ndj
# fuzzycat-issn --make-shelve -c basic -o names $^
|
