Skip to content

Commit ff04914

Browse files
docs: Update README and change license to Apache 2.0
- Improve README opening with clear DataJoint definition - Add key features list - Simplify badge table layout - Change license from LGPL-2.1 to Apache 2.0 - Add new LICENSE file with Apache 2.0 text - Copyright 2024 DataJoint Inc. and contributors 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 2f3e88b commit ff04914

File tree

2 files changed

+216
-78
lines changed

2 files changed

+216
-78
lines changed

LICENSE

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2024 DataJoint Inc. and contributors
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

README.md

Lines changed: 26 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,64 @@
1-
# Welcome to DataJoint for Python!
1+
# DataJoint for Python
2+
3+
DataJoint is an open-source Python framework for building scientific data pipelines.
4+
It implements the **Relational Workflow Model**—a paradigm that extends relational
5+
databases with native support for computational workflows.
6+
7+
**Key Features:**
8+
9+
- **Declarative schema design** — Define tables and relationships in Python
10+
- **Automatic dependency tracking** — Foreign keys encode workflow dependencies
11+
- **Built-in computation** — Imported and Computed tables run automatically
12+
- **Data integrity** — Referential integrity and transaction support
13+
- **Reproducibility** — Immutable data with full provenance
14+
15+
**Documentation:** https://docs.datajoint.com
216

317
<table>
4-
<!-- Thank Zarr for providing badge insights! -->
5-
<!-- https://github.com/zarr-developers/zarr-python/blob/main/README.md -->
618
<tr>
719
<td>PyPI</td>
820
<td>
921
<a href="https://pypi.org/project/datajoint/">
1022
<img src="https://img.shields.io/pypi/v/datajoint?color=blue" alt="pypi release" />
1123
</a>
12-
<br>
13-
<a href="https://pypi.org/project/datajoint/">
14-
<img src="https://img.shields.io/pypi/dm/datajoint?color=yellow" alt="pypi downloads" />
15-
</a>
1624
</td>
17-
</tr>
18-
<tr>
19-
<td>Conda Forge</td>
25+
<td>Conda</td>
2026
<td>
2127
<a href="https://anaconda.org/conda-forge/datajoint">
2228
<img src="https://img.shields.io/conda/vn/conda-forge/datajoint?color=brightgreen" alt="conda-forge release" />
2329
</a>
24-
<br>
25-
<a href="https://anaconda.org/conda-forge/datajoint">
26-
<img src="https://img.shields.io/conda/dn/conda-forge/datajoint?color=brightgreen" alt="conda-forge downloads" />
27-
</a>
2830
</td>
2931
</tr>
3032
<tr>
31-
<td>Since Release</td>
32-
<td>
33-
<a id="commit-since-release-link" href="https://github.com/datajoint/datajoint-python/compare/v0.14.6...master">
34-
<img id="commit-since-release-img" src="https://img.shields.io/github/commits-since/datajoint/datajoint-python/v0.14.6?color=red" alt="commit since last release" />
35-
</a>
36-
</td>
37-
</tr>
38-
<tr>
39-
<td>Test Status</td>
33+
<td>Tests</td>
4034
<td>
4135
<a href="https://github.com/datajoint/datajoint-python/actions/workflows/test.yaml">
4236
<img src="https://github.com/datajoint/datajoint-python/actions/workflows/test.yaml/badge.svg" alt="test status" />
4337
</a>
4438
</td>
45-
</tr>
46-
<tr>
47-
<td>Release Status</td>
48-
<td>
49-
<a href="https://github.com/datajoint/datajoint-python/actions/workflows/post_draft_release_published.yaml">
50-
<img src="https://github.com/datajoint/datajoint-python/actions/workflows/post_draft_release_published.yaml/badge.svg" alt="release status" />
51-
</a>
52-
</td>
53-
</tr>
54-
<tr>
55-
<td>Doc Status</td>
56-
<td>
57-
<a href="https://docs.datajoint.com">
58-
<img src="https://github.com/datajoint/datajoint-python/actions/workflows/pages/pages-build-deployment/badge.svg" alt="doc status" />
59-
</a>
60-
</td>
61-
</tr>
62-
<tr>
6339
<td>Coverage</td>
6440
<td>
6541
<a href="https://coveralls.io/github/datajoint/datajoint-python?branch=master">
66-
<img src="https://coveralls.io/repos/datajoint/datajoint-python/badge.svg?branch=master&service=github"/ alt="coverage">
42+
<img src="https://coveralls.io/repos/datajoint/datajoint-python/badge.svg?branch=master&service=github" alt="coverage">
6743
</a>
6844
</td>
6945
</tr>
70-
<tr>
71-
<td>Developer Chat</td>
72-
<td>
73-
<a href="https://datajoint.slack.com/">
74-
<img src="https://img.shields.io/badge/slack-datajoint-purple.svg" alt="datajoint slack"/>
75-
</a>
76-
</td>
77-
</tr>
7846
<tr>
7947
<td>License</td>
8048
<td>
81-
<a href="https://github.com/datajoint/datajoint-python/blob/master/LICENSE.txt">
82-
<img src="https://img.shields.io/github/license/datajoint/datajoint-python" alt="LGPL-2.1" />
49+
<a href="https://github.com/datajoint/datajoint-python/blob/master/LICENSE">
50+
<img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="Apache-2.0" />
51+
</a>
52+
</td>
53+
<td>Citation</td>
54+
<td>
55+
<a href="https://doi.org/10.1101/031658">
56+
<img src="https://img.shields.io/badge/DOI-10.1101/031658-blue.svg" alt="DOI">
8357
</a>
8458
</td>
8559
</tr>
86-
<tr>
87-
<td>Citation</td>
88-
<td>
89-
<a href="https://doi.org/10.1101/031658">
90-
<img src="https://img.shields.io/badge/DOI-10.1101/bioRxiv.031658-B31B1B.svg" alt="bioRxiv">
91-
</a>
92-
<br>
93-
<a href="https://doi.org/10.5281/zenodo.6829062">
94-
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.6829062.svg" alt="zenodo">
95-
</a>
96-
</td>
97-
</tr>
98-
9960
</table>
10061

101-
DataJoint for Python is a framework for scientific workflow management based on
102-
relational principles. DataJoint is built on the foundation of the relational data
103-
model and prescribes a consistent method for organizing, populating, computing, and
104-
querying data.
105-
106-
DataJoint was initially developed in 2009 by Dimitri Yatsenko in Andreas Tolias' Lab at
107-
Baylor College of Medicine for the distributed processing and management of large
108-
volumes of data streaming from regular experiments. Starting in 2011, DataJoint has
109-
been available as an open-source project adopted by other labs and improved through
110-
contributions from several developers.
111-
Presently, the primary developer of DataJoint open-source software is the company
112-
DataJoint (<https://datajoint.com>).
113-
11462
## Data Pipeline Example
11563

11664
![pipeline](https://raw.githubusercontent.com/datajoint/datajoint-python/master/images/pipeline.png)

0 commit comments

Comments
 (0)