forked from enviPath/enviPy
t03i
36879c266b
## Summary This PR improves the local development setup experience by adding Docker Compose and Makefile for streamlined setup. ## Changes - **Added `docker-compose.yml`**: for one-command PostgreSQL database setup - **Added `Makefile`**: Convenient shortcuts for common dev tasks (\`make setup\`, \`make dev\`, etc.) - **Updated `README.md`**: Quick development setup instructions using Make - - **Added**: RDkit installation pain point documentation - **Fixed**: Made Java feature properly dependent ## Why these changes? The application uses PostgreSQL-specific features (\`ArrayField\`) and requires an anonymous user created by the bootstrap command. This PR makes the setup process trivial for new developers: ```bash cp .env.local.example .env make setup # Starts DB, runs migrations, bootstraps data make dev # Starts development server ``` Java fix: Moved global Java import to inline to avoid everyone having to configure the Java path. Numerous changes to view and settings. - Applied ruff-formatting ## Testing Verified complete setup from scratch works with: - PostgreSQL running in Docker - All migrations applied - Bootstrap data loaded successfully - Anonymous user created - The development server starts correctly. Co-authored-by: Tobias O <tobias.olenyi@tum.de> Co-authored-by: Tobias O <tobias.olenyi@envipath.com> Co-authored-by: Liam <62733830+limmooo@users.noreply.github.com> Reviewed-on: enviPath/enviPy#143 Reviewed-by: jebus <lorsbach@envipath.com> Reviewed-by: liambrydon <lbry121@aucklanduni.ac.nz> Co-authored-by: t03i <mail+envipath@t03i.net> Co-committed-by: t03i <mail+envipath@t03i.net>
91 lines
3.1 KiB
TOML
91 lines
3.1 KiB
TOML
[project]
|
||
name = "envipy"
|
||
version = "0.1.0"
|
||
description = "Add your description here"
|
||
readme = "README.md"
|
||
requires-python = ">=3.12"
|
||
dependencies = [
|
||
"celery>=5.5.2",
|
||
"django>=5.2.1",
|
||
"django-extensions>=4.1",
|
||
"django-model-utils>=5.0.0",
|
||
"django-ninja>=1.4.1",
|
||
"django-oauth-toolkit>=3.0.1",
|
||
"django-polymorphic>=4.1.0",
|
||
"django-stubs>=5.2.4",
|
||
"enviformer",
|
||
"envipy-additional-information",
|
||
"envipy-ambit>=0.1.0",
|
||
"envipy-plugins",
|
||
"epam-indigo>=1.30.1",
|
||
"gunicorn>=23.0.0",
|
||
"networkx>=3.4.2",
|
||
"psycopg2-binary>=2.9.10",
|
||
"python-dotenv>=1.1.0",
|
||
"rdkit>=2025.3.2",
|
||
"redis>=6.1.0",
|
||
"requests>=2.32.3",
|
||
"scikit-learn>=1.6.1",
|
||
"sentry-sdk[django]>=2.32.0",
|
||
"setuptools>=80.8.0",
|
||
]
|
||
|
||
[tool.uv.sources]
|
||
enviformer = { git = "ssh://git@git.envipath.com/enviPath/enviformer.git", rev = "v0.1.2" }
|
||
envipy-plugins = { git = "ssh://git@git.envipath.com/enviPath/enviPy-plugins.git", rev = "v0.1.0" }
|
||
envipy-additional-information = { git = "ssh://git@git.envipath.com/enviPath/enviPy-additional-information.git", rev = "v0.1.4"}
|
||
envipy-ambit = { git = "ssh://git@git.envipath.com/enviPath/enviPy-ambit.git" }
|
||
|
||
[project.optional-dependencies]
|
||
ms-login = ["msal>=1.33.0"]
|
||
dev = [
|
||
"poethepoet>=0.37.0",
|
||
"pre-commit>=4.3.0",
|
||
"ruff>=0.13.3",
|
||
]
|
||
|
||
[tool.ruff]
|
||
line-length = 100
|
||
|
||
[tool.ruff.lint]
|
||
# Allow fix for all enabled rules (when `--fix`) is provided.
|
||
fixable = ["ALL"]
|
||
# Allow unused variables when underscore-prefixed.
|
||
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
|
||
|
||
[tool.ruff.format]
|
||
docstring-code-format = true
|
||
|
||
# 4. Ignore `E402` (import violations) in all `__init__.py` files, and in selected subdirectories.
|
||
[tool.ruff.lint.per-file-ignores]
|
||
"__init__.py" = ["E402"]
|
||
"**/{tests,docs,tools}/*" = ["E402"]
|
||
|
||
[tool.poe.tasks]
|
||
# Main tasks
|
||
setup = { sequence = ["db-up", "migrate", "bootstrap"], help = "Complete setup: start database, run migrations, and bootstrap data" }
|
||
dev = { cmd = "python manage.py runserver", help = "Start the development server", deps = ["db-up"] }
|
||
|
||
# Database tasks
|
||
db-up = { cmd = "docker compose -f docker-compose.dev.yml up -d", help = "Start PostgreSQL database using Docker Compose" }
|
||
db-down = { cmd = "docker compose -f docker-compose.dev.yml down", help = "Stop PostgreSQL database" }
|
||
|
||
# Full cleanup tasks
|
||
clean = { sequence = ["clean-db"], help = "Remove model files and database volumes (WARNING: destroys all data!)" }
|
||
clean-db = { cmd = "docker compose -f docker-compose.dev.yml down -v", help = "Removes the database container and volume." }
|
||
|
||
# Django tasks
|
||
migrate = { cmd = "python manage.py migrate", help = "Run database migrations" }
|
||
bootstrap = { shell = """
|
||
echo "Bootstrapping initial data..."
|
||
echo "This will take a bit ⏱️. Get yourself some coffee..."
|
||
python manage.py bootstrap
|
||
echo "✓ Bootstrap complete"
|
||
echo ""
|
||
echo "Default admin credentials:"
|
||
echo " Username: admin"
|
||
echo " Email: admin@envipath.com"
|
||
echo " Password: SuperSafe"
|
||
""", help = "Bootstrap initial data (anonymous user, packages, models)" }
|
||
shell = { cmd = "python manage.py shell", help = "Open Django shell" }
|