Skip to content

Commit

Permalink
Merge pull request #129 from pydanny/document-new-activate-args
Browse files Browse the repository at this point in the history 
Document new activate function arguments
  • Loading branch information
@pydanny
pydanny committed Oct 21, 2023
2 parents d22c761 + 42565da commit bde1df8
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 33 deletions.
10 changes: 9 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,15 @@ Then in the first cell enter:
```python
from dj_notebook import activate

plus = activate("DJANGO_SETTINGS_MODULE_VALUE")
plus = activate()

# If that throws an error, try one of the following:

# DJANGO_SETTINGS_MODULE_VALUE aka "book_store.settings"
# plus = activate("DJANGO_SETTINGS_MODULE_VALUE")

# Point to location of dotenv file with Django settings
# plus = activate(dotenv_file='.env')
```

In future cells, you can now load and run Django objects, including the ORM. This three line snippet should give an idea of what you can now do:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The ever-growing list of features:

```python
from dj_notebook import activate
plus = activate('book_store.settings')
plus = activate()
plus.User.objects.all()
```

Expand Down
75 changes: 44 additions & 31 deletions docs/usage.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,23 @@
"\n",
"from dj_notebook import activate\n",
"\n",
"plus = activate(\"DJANGO_SETTINGS_MODULE_VALUE\")\n",
"plus = activate()\n",
"```\n",
"\n",
"Then, find your project's `manage.py` file and open it. Copy whatever is being set to `DJANGO_SETTINGS_MODULE` as a string argument to `activate` function. \n",
"If that doesn't work, find your project's `manage.py` file and open it.\n",
"Copy whatever is being set to `DJANGO_SETTINGS_MODULE` as a string\n",
"argument to `activate` function like so:\n",
"\n",
"See below for an example that works with dj-notebook's Django test project: "
"```\n",
"plus = activate('book_store.settings')\n",
"```\n",
"\n",
"Here's an example that works with dj-notebook's test project: "
]
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": 10,
"metadata": {
"tags": [
"remove-input",
Expand All @@ -41,13 +47,13 @@
"\n",
"# project base\n",
"here = pathlib.Path(\".\").parent\n",
"KRAKEN_ROOT = (here / \"..\" / \"tests\" / \"django_test_project\").resolve()\n",
"sys.path.insert(0, str(KRAKEN_ROOT))"
"PROJECT_ROOT = (here / \"..\" / \"tests\" / \"django_test_project\").resolve()\n",
"sys.path.insert(0, str(PROJECT_ROOT))"
]
},
{
"cell_type": "code",
"execution_count": 9,
"execution_count": 11,
"metadata": {},
"outputs": [
{
Expand All @@ -64,9 +70,16 @@
"source": [
"from dj_notebook import activate\n",
"\n",
"# Find this in tests/django_test_project/manage.py\n",
"# Find our test project in tests/django_test_project/manage.py\n",
"# https://github.com/pydanny/dj-notebook/blob/main/tests/django_test_project/manage.py\n",
"plus = activate(\"book_store.settings\")"
"\n",
"# plus = activate()\n",
"\n",
"# If that throws an error, try one of the following:\n",
"plus = activate(\"book_store.settings\")\n",
"\n",
"# Point to location of dotenv file with Django settings\n",
"# plus = activate(dotenv_file='.env')"
]
},
{
Expand All @@ -78,7 +91,7 @@
},
{
"cell_type": "code",
"execution_count": 10,
"execution_count": 12,
"metadata": {},
"outputs": [
{
Expand All @@ -87,7 +100,7 @@
"<QuerySet [<User: Audrey>, <User: Daniel>]>"
]
},
"execution_count": 10,
"execution_count": 12,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -121,7 +134,7 @@
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": 13,
"metadata": {},
"outputs": [
{
Expand All @@ -130,7 +143,7 @@
"<QuerySet [<User: Audrey>, <User: Daniel>]>"
]
},
"execution_count": 11,
"execution_count": 13,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -148,7 +161,7 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": 14,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -181,7 +194,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": 15,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -221,8 +234,8 @@
" <tbody>\n",
" <tr>\n",
" <th>0</th>\n",
" <td>28</td>\n",
" <td>!zRpp7AdeznJBMP86yxdufQYHSN0ZvhAx78vbKfup</td>\n",
" <td>30</td>\n",
" <td>!e91xGexuejHJTtcK5UK6VLPs74uTojmlMVbBCHF1</td>\n",
" <td>None</td>\n",
" <td>False</td>\n",
" <td>Audrey</td>\n",
Expand All @@ -231,12 +244,12 @@
" <td></td>\n",
" <td>False</td>\n",
" <td>True</td>\n",
" <td>2023-10-10 15:26:05.802032+00:00</td>\n",
" <td>2023-10-21 12:54:07.318920+00:00</td>\n",
" </tr>\n",
" <tr>\n",
" <th>1</th>\n",
" <td>29</td>\n",
" <td>!39wU3dmzbN3ZhhuJ5TDpgweohnqfKCuZQ140hKHE</td>\n",
" <td>31</td>\n",
" <td>!wqNcAZOEw4KUIQdaIzMyf46lgEYKbrLsGDHZgqtE</td>\n",
" <td>None</td>\n",
" <td>False</td>\n",
" <td>Daniel</td>\n",
Expand All @@ -245,27 +258,27 @@
" <td></td>\n",
" <td>False</td>\n",
" <td>True</td>\n",
" <td>2023-10-10 15:26:05.803252+00:00</td>\n",
" <td>2023-10-21 12:54:07.319889+00:00</td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n",
"</div>"
],
"text/plain": [
" id password last_login is_superuser \\\n",
"0 28 !zRpp7AdeznJBMP86yxdufQYHSN0ZvhAx78vbKfup None False \n",
"1 29 !39wU3dmzbN3ZhhuJ5TDpgweohnqfKCuZQ140hKHE None False \n",
"0 30 !e91xGexuejHJTtcK5UK6VLPs74uTojmlMVbBCHF1 None False \n",
"1 31 !wqNcAZOEw4KUIQdaIzMyf46lgEYKbrLsGDHZgqtE None False \n",
"\n",
" username first_name last_name email is_staff is_active \\\n",
"0 Audrey False True \n",
"1 Daniel False True \n",
"\n",
" date_joined \n",
"0 2023-10-10 15:26:05.802032+00:00 \n",
"1 2023-10-10 15:26:05.803252+00:00 "
"0 2023-10-21 12:54:07.318920+00:00 \n",
"1 2023-10-21 12:54:07.319889+00:00 "
]
},
"execution_count": 13,
"execution_count": 15,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -287,13 +300,13 @@
},
{
"cell_type": "code",
"execution_count": 14,
"execution_count": 16,
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
"<img src=\"https://mermaid.ink/img/Y2xhc3NEaWFncmFtCiAgY2xhc3MgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfQWJzdHJhY3RVc2VyWyJkamFuZ28uY29udHJpYi5hdXRoLm1vZGVsczo6QWJzdHJhY3RVc2VyIl0KICBkamFuZ29fY29udHJpYl9hdXRoX21vZGVsc19QZXJtaXNzaW9uc01peGluIDx8LS0gZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfQWJzdHJhY3RVc2VyCiAgY2xhc3MgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfVXNlclsiZGphbmdvLmNvbnRyaWIuYXV0aC5tb2RlbHM6OlVzZXIiXQogIGRqYW5nb19kYl9tb2RlbHNfdXRpbHNfQWx0ZXJzRGF0YSA8fC0tIGRqYW5nb19kYl9tb2RlbHNfYmFzZV9Nb2RlbAogIGNsYXNzIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX1Blcm1pc3Npb25zTWl4aW5bImRqYW5nby5jb250cmliLmF1dGgubW9kZWxzOjpQZXJtaXNzaW9uc01peGluIl0KICBkamFuZ29fZGJfbW9kZWxzX2Jhc2VfTW9kZWwgPHwtLSBkamFuZ29fY29udHJpYl9hdXRoX21vZGVsc19QZXJtaXNzaW9uc01peGluCiAgZGphbmdvX2NvbnRyaWJfYXV0aF9iYXNlX3VzZXJfQWJzdHJhY3RCYXNlVXNlciA8fC0tIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX0Fic3RyYWN0VXNlcgogIGNsYXNzIGRqYW5nb19kYl9tb2RlbHNfdXRpbHNfQWx0ZXJzRGF0YVsiZGphbmdvLmRiLm1vZGVscy51dGlsczo6QWx0ZXJzRGF0YSJdCiAgY2xhc3MgZGphbmdvX2RiX21vZGVsc19iYXNlX01vZGVsWyJkamFuZ28uZGIubW9kZWxzLmJhc2U6Ok1vZGVsIl0KICBjbGFzcyBkamFuZ29fY29udHJpYl9hdXRoX2Jhc2VfdXNlcl9BYnN0cmFjdEJhc2VVc2VyWyJkamFuZ28uY29udHJpYi5hdXRoLmJhc2VfdXNlcjo6QWJzdHJhY3RCYXNlVXNlciJdCiAgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfQWJzdHJhY3RVc2VyIDx8LS0gZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfVXNlcgogIGRqYW5nb19kYl9tb2RlbHNfYmFzZV9Nb2RlbCA8fC0tIGRqYW5nb19jb250cmliX2F1dGhfYmFzZV91c2VyX0Fic3RyYWN0QmFzZVVzZXI=\"/>"
"<img src=\"https://mermaid.ink/img/Y2xhc3NEaWFncmFtCiAgY2xhc3MgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfVXNlclsiZGphbmdvLmNvbnRyaWIuYXV0aC5tb2RlbHM6OlVzZXIiXQogIGRqYW5nb19kYl9tb2RlbHNfYmFzZV9Nb2RlbCA8fC0tIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX1Blcm1pc3Npb25zTWl4aW4KICBjbGFzcyBkamFuZ29fY29udHJpYl9hdXRoX21vZGVsc19BYnN0cmFjdFVzZXJbImRqYW5nby5jb250cmliLmF1dGgubW9kZWxzOjpBYnN0cmFjdFVzZXIiXQogIGRqYW5nb19kYl9tb2RlbHNfdXRpbHNfQWx0ZXJzRGF0YSA8fC0tIGRqYW5nb19kYl9tb2RlbHNfYmFzZV9Nb2RlbAogIGNsYXNzIGRqYW5nb19kYl9tb2RlbHNfYmFzZV9Nb2RlbFsiZGphbmdvLmRiLm1vZGVscy5iYXNlOjpNb2RlbCJdCiAgY2xhc3MgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfUGVybWlzc2lvbnNNaXhpblsiZGphbmdvLmNvbnRyaWIuYXV0aC5tb2RlbHM6OlBlcm1pc3Npb25zTWl4aW4iXQogIGRqYW5nb19jb250cmliX2F1dGhfYmFzZV91c2VyX0Fic3RyYWN0QmFzZVVzZXIgPHwtLSBkamFuZ29fY29udHJpYl9hdXRoX21vZGVsc19BYnN0cmFjdFVzZXIKICBkamFuZ29fZGJfbW9kZWxzX2Jhc2VfTW9kZWwgPHwtLSBkamFuZ29fY29udHJpYl9hdXRoX2Jhc2VfdXNlcl9BYnN0cmFjdEJhc2VVc2VyCiAgZGphbmdvX2NvbnRyaWJfYXV0aF9tb2RlbHNfUGVybWlzc2lvbnNNaXhpbiA8fC0tIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX0Fic3RyYWN0VXNlcgogIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX0Fic3RyYWN0VXNlciA8fC0tIGRqYW5nb19jb250cmliX2F1dGhfbW9kZWxzX1VzZXIKICBjbGFzcyBkamFuZ29fZGJfbW9kZWxzX3V0aWxzX0FsdGVyc0RhdGFbImRqYW5nby5kYi5tb2RlbHMudXRpbHM6OkFsdGVyc0RhdGEiXQogIGNsYXNzIGRqYW5nb19jb250cmliX2F1dGhfYmFzZV91c2VyX0Fic3RyYWN0QmFzZVVzZXJbImRqYW5nby5jb250cmliLmF1dGguYmFzZV91c2VyOjpBYnN0cmFjdEJhc2VVc2VyIl0=\"/>"
],
"text/plain": [
"<IPython.core.display.Image object>"
Expand All @@ -320,7 +333,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": 17,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -363,7 +376,7 @@
},
{
"cell_type": "code",
"execution_count": 16,
"execution_count": 18,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -417,7 +430,7 @@
},
{
"cell_type": "code",
"execution_count": 17,
"execution_count": 19,
"metadata": {},
"outputs": [
{
Expand Down

0 comments on commit bde1df8

Please sign in to comment.