mirror of
https://github.com/imartinez/privateGPT.git
synced 2025-09-16 23:30:48 +00:00
36f69eed0f
* Refactor documentation architecture Split into several `tab` and sections * Fix Fern's docs.yml after PR review Thank you Danny! Co-authored-by: dannysheridan <danny@buildwithfern.com> * Re-add quickstart in the overview tab It went missing after a refactoring of the doc architecture * Documentation writing * Adapt Makefile to fern documentation * Do not create overlapping page names in fern documentation This is causing 500. Thank you to @dsinghvi for the troubleshooting and the help! * Add a readme to help to understand how fern documentation work and how to add new pages * Rework the welcome view Redirects directly users to installation guide with links for people that are not familiar with documentation browsing. * Simplify the quickstart guide * PR feedback on installation guide A ton of refactoring can still be made there * PR feedback on ingestion * PR feedback on ingestion splitting * Rename section on LLM * Fix missing word in list of LLMs --------- Co-authored-by: dannysheridan <danny@buildwithfern.com>
55 lines
1.8 KiB
Makefile
55 lines
1.8 KiB
Makefile
# Any args passed to the make script, use with $(call args, default_value)
|
|
args = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
|
|
|
|
########################################################################################################################
|
|
# Quality checks
|
|
########################################################################################################################
|
|
|
|
test:
|
|
PYTHONPATH=. poetry run pytest tests
|
|
|
|
test-coverage:
|
|
PYTHONPATH=. poetry run pytest tests --cov private_gpt --cov-report term --cov-report=html --cov-report xml --junit-xml=tests-results.xml
|
|
|
|
black:
|
|
poetry run black . --check
|
|
|
|
ruff:
|
|
poetry run ruff check private_gpt tests
|
|
|
|
format:
|
|
poetry run black .
|
|
poetry run ruff check private_gpt tests --fix
|
|
|
|
mypy:
|
|
poetry run mypy private_gpt
|
|
|
|
check:
|
|
make format
|
|
make mypy
|
|
|
|
########################################################################################################################
|
|
# Run
|
|
########################################################################################################################
|
|
|
|
run:
|
|
poetry run python -m private_gpt
|
|
|
|
dev-windows:
|
|
(set PGPT_PROFILES=local & poetry run python -m uvicorn private_gpt.main:app --reload --port 8001)
|
|
|
|
dev:
|
|
PYTHONUNBUFFERED=1 PGPT_PROFILES=local poetry run python -m uvicorn private_gpt.main:app --reload --port 8001
|
|
|
|
########################################################################################################################
|
|
# Misc
|
|
########################################################################################################################
|
|
|
|
api-docs:
|
|
PGPT_PROFILES=mock poetry run python scripts/extract_openapi.py private_gpt.main:app --out fern/openapi/openapi.json
|
|
|
|
ingest:
|
|
@poetry run python scripts/ingest_folder.py $(call args)
|
|
|
|
wipe:
|
|
poetry run python scripts/utils.py wipe
|