mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Samuel Colvin
33b7d52d31
* moving docs to mkdocs * transfering readme to md and more * fixing build * splitting usage.md * improving schema.md and index.md * fix make_history.rst * models intro * working on data conversation and required fields * more fixes to models.md * list all standard types supported * list of pydantic types * tweaks * update links in code * Apply suggestions from code review incorporate @dmontagu's suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more missed suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more corrects. * cleanup * Field order warning * fix and regenerate benchmarks * format examples better, cleanup * improve schema mapping table * correct highlighting file types in schema.md * add redirects in javascript * add logo
110 lines
2.2 KiB
Makefile
110 lines
2.2 KiB
Makefile
.DEFAULT_GOAL := all
|
|
isort = isort -rc pydantic tests
|
|
black = black -S -l 120 --target-version py36 pydantic tests
|
|
|
|
.PHONY: install
|
|
install:
|
|
pip install -U setuptools pip
|
|
pip install -U -r requirements.txt
|
|
SKIP_CYTHON=1 pip install -e .
|
|
|
|
.PHONY: build-cython-trace
|
|
build-cython-trace:
|
|
python setup.py build_ext --force --inplace --define CYTHON_TRACE
|
|
|
|
.PHONY: build-cython
|
|
build-cython:
|
|
python setup.py build_ext --inplace
|
|
|
|
.PHONY: format
|
|
format:
|
|
$(isort)
|
|
$(black)
|
|
|
|
.PHONY: lint
|
|
lint:
|
|
flake8 pydantic/ tests/
|
|
$(isort) --check-only
|
|
$(black) --check
|
|
|
|
.PHONY: check-dist
|
|
check-dist:
|
|
python setup.py check -ms
|
|
SKIP_CYTHON=1 python setup.py sdist
|
|
twine check dist/*
|
|
|
|
.PHONY: mypy
|
|
mypy:
|
|
mypy pydantic
|
|
|
|
.PHONY: test
|
|
test:
|
|
pytest --cov=pydantic
|
|
@python tests/try_assert.py
|
|
|
|
.PHONY: testcov
|
|
testcov: test
|
|
@echo "building coverage html"
|
|
@coverage html
|
|
|
|
.PHONY: testcov-compile
|
|
testcov-compile: build-cython-trace test
|
|
@echo "building coverage html"
|
|
@coverage html
|
|
|
|
.PHONY: test-examples
|
|
test-examples:
|
|
@echo "running examples"
|
|
@find docs/examples -type f -name '*.py' | xargs -I'{}' sh -c 'python {} >/dev/null 2>&1 || (echo "{} failed")'
|
|
|
|
.PHONY: all
|
|
all: testcov lint mypy
|
|
|
|
.PHONY: benchmark-all
|
|
benchmark-all:
|
|
python benchmarks/run.py
|
|
|
|
.PHONY: benchmark-pydantic
|
|
benchmark-pydantic:
|
|
python benchmarks/run.py pydantic-only
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf `find . -name __pycache__`
|
|
rm -f `find . -type f -name '*.py[co]' `
|
|
rm -f `find . -type f -name '*~' `
|
|
rm -f `find . -type f -name '.*~' `
|
|
rm -rf .cache
|
|
rm -rf .pytest_cache
|
|
rm -rf .mypy_cache
|
|
rm -rf htmlcov
|
|
rm -rf *.egg-info
|
|
rm -f .coverage
|
|
rm -f .coverage.*
|
|
rm -rf build
|
|
rm -rf dist
|
|
rm -f pydantic/*.c pydantic/*.so
|
|
python setup.py clean
|
|
rm -rf site
|
|
rm -rf docs/_build
|
|
|
|
.PHONY: docs
|
|
docs:
|
|
./docs/build/main.py
|
|
mkdocs build
|
|
@# to work with the old sphinx build and deploy:
|
|
@rm -rf docs/_build/
|
|
@mkdir docs/_build/
|
|
@cp -r site docs/_build/html
|
|
|
|
.PHONY: docs-serve
|
|
docs-serve:
|
|
./docs/build/main.py
|
|
mkdocs serve
|
|
|
|
.PHONY: publish
|
|
publish: docs
|
|
zip -r site.zip site
|
|
@curl -H "Content-Type: application/zip" -H "Authorization: Bearer ${NETLIFY}" \
|
|
--data-binary "@site.zip" https://api.netlify.com/api/v1/sites/pydantic-docs.netlify.com/deploys
|