Skip to content

Commit 6de7452

Browse files
guzman-raphaelguzman-raphael
authored
Merge pull request #1075 from guzman-raphael/dev-improvements
Prepare for release
2 parents 001ed49 + 3062359 commit 6de7452

File tree

6 files changed

+61
-47
lines changed

6 files changed

+61
-47
lines changed

‎.devcontainer/devcontainer.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@
1616
"ghcr.io/guiyomh/features/vim:0": {}
1717
},
1818
"onCreateCommand": "pip install -e .",
19-
"postStartCommand": "MYSQL_VER=5.7 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml up --build -d",
19+
"postStartCommand": "MYSQL_VER=8.0 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml down && MYSQL_VER=8.0 MINIO_VER=RELEASE.2022-08-11T04-37-28Z docker compose -f local-docker-compose.yml up --build --wait",
20+
"forwardPorts": [
21+
80,
22+
443,
23+
3306,
24+
8080,
25+
9000
26+
],
2027
"customizations": {
2128
"vscode": {
2229
"extensions": [

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Release notes
22

3-
### 0.14.0 -- Feb 10, 2023
3+
### 0.14.0 -- Feb 13, 2023
44
- Added - `json` data type ([#245](https://github.com/datajoint/datajoint-python/issues/245)) PR [#1051](https://github.com/datajoint/datajoint-python/pull/1051)
55
- Fixed - Activating a schema requires all tables to exist even if `create_tables=False` PR [#1058](https://github.com/datajoint/datajoint-python/pull/1058)
66
- Changed - Populate call with `reserve_jobs=True` to exclude `error` and `ignore` keys - PR [#1062](https://github.com/datajoint/datajoint-python/pull/1062)

‎LNX-docker-compose.yml

+3-4
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,14 @@ services:
5656
# - "80:80"
5757
# - "443:443"
5858
# - "3306:3306"
59+
app:
60+
<<: *net
61+
image: datajoint/djtest:py${PY_VER}-${DISTRO}
5962
depends_on:
6063
db:
6164
condition: service_healthy
6265
minio:
6366
condition: service_healthy
64-
app:
65-
<<: *net
66-
image: datajoint/djtest:py${PY_VER}-${DISTRO}
67-
depends_on:
6867
fakeservices.datajoint.io:
6968
condition: service_healthy
7069
environment:

‎docs/src/develop.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,28 @@
22

33
Included with the codebase is the recommended development environment configured using [DevContainer](https://containers.dev/).
44

5-
## Launch Development Environment
5+
## Launch Environment
66

77
Here are some options that provide a great developer experience:
88

99
- **Cloud-based IDE**: (*recommended*)
1010
- Launch using [GitHub Codespaces](https://github.com/features/codespaces) using the option `Create codespace on master` in the codebase repository on your fork.
11-
- Build time for a 2-Core codespace is **~5m**. This is done infrequently and cached for convenience.
12-
- Start time for a 2-Core codespace is **~1m**. This will pull the built codespace from cache when you need it.
13-
- Tip: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
11+
- Build time for a 2-Core codespace is **~6m**. This is done infrequently and cached for convenience.
12+
- Start time for a 2-Core codespace is **~2m**. This will pull the built codespace from cache when you need it.
13+
- *Tip*: GitHub auto names the codespace but you can rename the codespace so that it is easier to identify later.
1414
- **Local IDE**:
1515
- Ensure you have [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
1616
- Ensure you have [Docker](https://docs.docker.com/get-docker/)
1717
- Ensure you have [VSCode](https://code.visualstudio.com/)
1818
- Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
1919
- `git clone` the codebase repository and open it in VSCode
2020
- Use the `Dev Containers extension` to `Reopen in Container` (More info in the `Getting started` included with the extension)
21-
- Your environment will finish loading once the file tree is populated and the terminal become active
21+
22+
You will know your environment has finished loading once you see a terminal open related to `Running postStartCommand` with a final message: `Done`.
2223

2324
## Features
2425

25-
Once you've successfully launched the development environment, you'll be able to take advantage of our developer tooling to help improve productivity.
26+
Once you've successfully launched the development environment, you'll be able to take advantage of our developer tooling to help improve productivity and quality.
2627

2728
### Syntax Tests
2829

‎docs/src/tutorials/json.ipynb

+42-30
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@
99
"# Using the `json` type"
1010
]
1111
},
12+
{
13+
"cell_type": "markdown",
14+
"id": "62450023",
15+
"metadata": {},
16+
"source": [
17+
"> ⚠️ Note the following before using the `json` type\n",
18+
"> - Supported only for MySQL >= 8.0 when [JSON_VALUE](https://dev.mysql.com/doc/refman/8.0/en/json-search-functions.html#function_json-value) introduced.\n",
19+
"> - Equivalent Percona is fully-compatible.\n",
20+
"> - MariaDB is not supported since [JSON_VALUE](https://mariadb.com/kb/en/json_value/#syntax) does not allow type specification like MySQL's.\n",
21+
"> - Not yet supported in DataJoint MATLAB"
22+
]
23+
},
1224
{
1325
"attachments": {},
1426
"cell_type": "markdown",
@@ -22,7 +34,7 @@
2234
},
2335
{
2436
"cell_type": "code",
25-
"execution_count": 2,
37+
"execution_count": 1,
2638
"id": "bc0b6f54-8f11-45f4-bf8d-e1058ee0056f",
2739
"metadata": {},
2840
"outputs": [],
@@ -54,16 +66,16 @@
5466
},
5567
{
5668
"cell_type": "code",
57-
"execution_count": 3,
69+
"execution_count": 2,
5870
"id": "dc318298-b819-4f06-abbd-7bb7544dd431",
5971
"metadata": {},
6072
"outputs": [
6173
{
6274
"name": "stderr",
6375
"output_type": "stream",
6476
"text": [
65-
"[2023-02-08 23:40:24,660][INFO]: Connecting root@fakeservices.datajoint.io:3306\n",
66-
"[2023-02-08 23:40:25,454][INFO]: Connected root@fakeservices.datajoint.io:3306\n"
77+
"[2023-02-12 00:14:33,027][INFO]: Connecting root@fakeservices.datajoint.io:3306\n",
78+
"[2023-02-12 00:14:33,039][INFO]: Connected root@fakeservices.datajoint.io:3306\n"
6779
]
6880
}
6981
],
@@ -73,7 +85,7 @@
7385
},
7486
{
7587
"cell_type": "code",
76-
"execution_count": 4,
88+
"execution_count": 3,
7789
"id": "4aaf96db-85d9-4e94-a4c3-3558f4cc6671",
7890
"metadata": {},
7991
"outputs": [],
@@ -108,7 +120,7 @@
108120
},
109121
{
110122
"cell_type": "code",
111-
"execution_count": 5,
123+
"execution_count": 4,
112124
"id": "30f0d62e",
113125
"metadata": {},
114126
"outputs": [],
@@ -150,7 +162,7 @@
150162
},
151163
{
152164
"cell_type": "code",
153-
"execution_count": 6,
165+
"execution_count": 5,
154166
"id": "b532e16c",
155167
"metadata": {},
156168
"outputs": [],
@@ -194,7 +206,7 @@
194206
},
195207
{
196208
"cell_type": "code",
197-
"execution_count": 7,
209+
"execution_count": 6,
198210
"id": "0e3b517c",
199211
"metadata": {},
200212
"outputs": [
@@ -279,7 +291,7 @@
279291
" (Total: 3)"
280292
]
281293
},
282-
"execution_count": 7,
294+
"execution_count": 6,
283295
"metadata": {},
284296
"output_type": "execute_result"
285297
}
@@ -306,7 +318,7 @@
306318
},
307319
{
308320
"cell_type": "code",
309-
"execution_count": 8,
321+
"execution_count": 7,
310322
"id": "81efda24",
311323
"metadata": {},
312324
"outputs": [
@@ -387,7 +399,7 @@
387399
" (Total: 1)"
388400
]
389401
},
390-
"execution_count": 8,
402+
"execution_count": 7,
391403
"metadata": {},
392404
"output_type": "execute_result"
393405
}
@@ -399,7 +411,7 @@
399411
},
400412
{
401413
"cell_type": "code",
402-
"execution_count": 9,
414+
"execution_count": 8,
403415
"id": "fd7b855d",
404416
"metadata": {},
405417
"outputs": [
@@ -480,7 +492,7 @@
480492
" (Total: 1)"
481493
]
482494
},
483-
"execution_count": 9,
495+
"execution_count": 8,
484496
"metadata": {},
485497
"output_type": "execute_result"
486498
}
@@ -492,7 +504,7 @@
492504
},
493505
{
494506
"cell_type": "code",
495-
"execution_count": 10,
507+
"execution_count": 9,
496508
"id": "b76ebb75",
497509
"metadata": {},
498510
"outputs": [
@@ -573,7 +585,7 @@
573585
" (Total: 1)"
574586
]
575587
},
576-
"execution_count": 10,
588+
"execution_count": 9,
577589
"metadata": {},
578590
"output_type": "execute_result"
579591
}
@@ -585,7 +597,7 @@
585597
},
586598
{
587599
"cell_type": "code",
588-
"execution_count": 11,
600+
"execution_count": 10,
589601
"id": "b787784c",
590602
"metadata": {},
591603
"outputs": [
@@ -668,7 +680,7 @@
668680
" (Total: 2)"
669681
]
670682
},
671-
"execution_count": 11,
683+
"execution_count": 10,
672684
"metadata": {},
673685
"output_type": "execute_result"
674686
}
@@ -709,7 +721,7 @@
709721
},
710722
{
711723
"cell_type": "code",
712-
"execution_count": 14,
724+
"execution_count": 11,
713725
"id": "8fb8334a",
714726
"metadata": {},
715727
"outputs": [
@@ -800,7 +812,7 @@
800812
" (Total: 3)"
801813
]
802814
},
803-
"execution_count": 14,
815+
"execution_count": 11,
804816
"metadata": {},
805817
"output_type": "execute_result"
806818
}
@@ -816,7 +828,7 @@
816828
},
817829
{
818830
"cell_type": "code",
819-
"execution_count": 15,
831+
"execution_count": 12,
820832
"id": "bb5f0448",
821833
"metadata": {},
822834
"outputs": [
@@ -828,7 +840,7 @@
828840
" {'name': 'marketing', 'car_name': None, 'car_length': None}]"
829841
]
830842
},
831-
"execution_count": 15,
843+
"execution_count": 12,
832844
"metadata": {},
833845
"output_type": "execute_result"
834846
}
@@ -839,7 +851,7 @@
839851
},
840852
{
841853
"cell_type": "code",
842-
"execution_count": 16,
854+
"execution_count": 13,
843855
"id": "a307dfd7",
844856
"metadata": {},
845857
"outputs": [
@@ -930,7 +942,7 @@
930942
" (Total: 3)"
931943
]
932944
},
933-
"execution_count": 16,
945+
"execution_count": 13,
934946
"metadata": {},
935947
"output_type": "execute_result"
936948
}
@@ -946,7 +958,7 @@
946958
},
947959
{
948960
"cell_type": "code",
949-
"execution_count": 17,
961+
"execution_count": 14,
950962
"id": "8a93dbf9",
951963
"metadata": {},
952964
"outputs": [
@@ -958,7 +970,7 @@
958970
" {'name': 'marketing', 'car_name': None, 'car_length': None}]"
959971
]
960972
},
961-
"execution_count": 17,
973+
"execution_count": 14,
962974
"metadata": {},
963975
"output_type": "execute_result"
964976
}
@@ -986,7 +998,7 @@
986998
},
987999
{
9881000
"cell_type": "code",
989-
"execution_count": 18,
1001+
"execution_count": 16,
9901002
"id": "0e739932",
9911003
"metadata": {},
9921004
"outputs": [
@@ -1004,8 +1016,8 @@
10041016
}
10051017
],
10061018
"source": [
1007-
"definition = Team.describe()\n",
1008-
"print(definition)"
1019+
"rebuilt_definition = Team.describe()\n",
1020+
"print(rebuilt_definition)"
10091021
]
10101022
},
10111023
{
@@ -1027,7 +1039,7 @@
10271039
},
10281040
{
10291041
"cell_type": "code",
1030-
"execution_count": 19,
1042+
"execution_count": 17,
10311043
"id": "d9cc28a3-3ffd-4126-b7e9-bc6365040b93",
10321044
"metadata": {},
10331045
"outputs": [],
@@ -1046,7 +1058,7 @@
10461058
],
10471059
"metadata": {
10481060
"kernelspec": {
1049-
"display_name": "Python 3",
1061+
"display_name": "Python 3.7.16 64-bit",
10501062
"language": "python",
10511063
"name": "python3"
10521064
},

‎local-docker-compose.yml

-5
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,5 @@ services:
6262
- "443:443"
6363
- "3306:3306"
6464
- "9000:9000"
65-
depends_on:
66-
db:
67-
condition: service_healthy
68-
minio:
69-
condition: service_healthy
7065
networks:
7166
main:

0 commit comments

Comments
 (0)