datajoint-python

(★ 197)

Relational Workflows: where database schemas define executable data pipelines.

File Explorer

Download Latest Version (.zip)

- - rfc.yml
- - bug_report.md
  - feature_request.md
  - improvement_request.md
- - close_inactive_issues_prs.yaml
  - draft_release.yaml
  - lint.yaml
  - post_draft_release_published.yaml
  - test.yaml
- dependabot.yml
- release_drafter.yaml
- pipeline.svg
- - __init__.py
  - autopopulate.py
  - blob.py
  - cli.py
  - codecs.py
  - condition.py
  - connection.py
  - declare.py
  - dependencies.py
  - deploy.py
  - diagram.py
  - errors.py
  - expression.py
  - gc.py
  - hash_registry.py
  - heading.py
  - instance.py
  - jobs.py
  - lineage.py
  - logging.py
  - migrate.py
  - objectref.py
  - preview.py
  - schemas.py
  - settings.py
  - spark.py
  - staged_insert.py
  - storage.py
  - storage_adapter.py
  - table.py
  - types.py
  - user_tables.py
  - utils.py
  - version.py
- - __init__.py
  - test_aggr_regressions.py
  - test_alter.py
  - test_attach.py
  - test_autopopulate.py
  - test_blob.py
  - test_blob_matlab.py
  - test_cascade_delete.py
  - test_cascade_integrity.py
  - test_cascading_delete.py
  - test_cli.py
  - test_codec_chaining.py
  - test_codecs.py
  - test_connection.py
  - test_declare.py
  - test_dependencies.py
  - test_diagram.py
  - test_diagram_bundle_edge.py
  - test_diagram_edge_weight.py
  - test_diagram_nocontext.py
  - test_diagram_style.py
  - test_fetch.py
  - test_fetch_same.py
  - test_fk_index.py
  - test_foreign_keys.py
  - test_gc.py
  - test_groupby.py
  - test_hash_storage.py
  - test_hidden_job_metadata.py
  - test_insert.py
  - test_jobs.py
  - test_json.py
  - test_multi_backend.py
  - test_nan.py
  - test_npy_codec.py
  - test_object.py
  - test_privileges.py
  - test_reconnection.py
  - test_relation.py
  - test_relation_u.py
  - test_relational_operand.py
  - test_schema.py
  - test_schema_keywords.py
  - test_semantic_matching.py
  - test_skip_duplicates.py
  - test_tls.py
  - test_trace.py
  - test_type_aliases.py
  - test_university.py
  - test_update1.py
  - test_utils.py
  - test_uuid.py
  - test_virtual_module.py
- - __init__.py
  - test_adapters.py
  - test_codecs.py
  - test_condition.py
  - test_connection_warning.py
  - test_declare_hidden_attribute.py
  - test_deploy.py
  - test_fetch_compat.py
  - test_gc.py
  - test_lazy_imports.py
  - test_logging.py
  - test_pk_rules.py
  - test_settings.py
  - test_spark.py
  - test_storage_adapter.py
  - test_storage_urls.py
  - test_thread_safe.py
- __init__.py
- conftest.py
- schema.py
- schema_advanced.py
- schema_aggr_regress.py
- schema_alter.py
- schema_codecs.py
- schema_external.py
- schema_object.py
- schema_privileges.py
- schema_simple.py
- schema_type_aliases.py
- schema_university.py
- schema_uuid.py
- test_package.py
.coveragerc
.dockerignore
.gitattributes
.gitignore
.pre-commit-config.yaml
activate.sh
CHANGELOG-archive.md
CONTRIBUTING.md
docker-compose.yaml
Dockerfile
LICENSE
pixi.lock
pyproject.toml
README.md
RELEASE_MEMO.md

# Installation Guide

1. Get the code

git clone https://github.com/datajoint/datajoint-python

Downloads the entire project code from GitHub to your computer.

cd datajoint-python

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install datajoint

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install datajoint

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.