- Moved optional pip packages to requirements_extra.txt

- Added documentation in Coding-Introduction.md for how to enable Jupyter notebook support
This commit is contained in:
duysqubix 2020-12-17 15:34:39 +00:00
parent e70a731e7f
commit 9605e3e64d
3 changed files with 34 additions and 4 deletions

View file

@ -38,10 +38,38 @@ That is, enter `evennia.` and press the `<TAB>` key. This will show you all the
available at the top level of Evennia's "flat API". See the [flat API](../Evennia-API) page for more available at the top level of Evennia's "flat API". See the [flat API](../Evennia-API) page for more
info on how to explore it efficiently. info on how to explore it efficiently.
#### Jupyter Notebook Support
You can now explore evennia interactively with jupyter notebooks. There are a few extra steps that must be taken in order for this to work:
# [open a new console/terminal]
# [activate your evennia virtualenv in this console/terminal]
cd evennia
pip install -r requirements_extra.txt # this installs optional, but necessary modules for this to work.
cd mygame # make sure you are in root of your grame
evennia shell_plus --notebook& # this will start the notebook in the background
Open an existing, or create, a notebook and in the first cell you must run:
```python
import evennia
evennia._init()
```
This will initialize all module level variables located in `evennia.__init__`.
Now you have the same support as `evennia shell`, but in a more visual and persistent form.
*It is important to remember, everytime the kernel restarts within a notebook you must first run
`evennia._init()`*
You can complement your exploration by peeking at the sections of the much more detailed You can complement your exploration by peeking at the sections of the much more detailed
[Evennia Component overview](../Components/Components-Overview). The [Tutorials](../Howto/Howto-Overview) section also contains a growing collection [Evennia Component overview](../Components/Components-Overview). The [Tutorials](../Howto/Howto-Overview) section also contains a growing collection
of system- or implementation-specific help. of system- or implementation-specific help.
### Use a python syntax checker ### Use a python syntax checker
Evennia works by importing your own modules and running them as part of the server. Whereas Evennia Evennia works by importing your own modules and running them as part of the server. Whereas Evennia

View file

@ -8,12 +8,9 @@ pytz
djangorestframework >= 3.10.3, < 3.12 djangorestframework >= 3.10.3, < 3.12
django-filter >= 2.2.0, < 2.3 django-filter >= 2.2.0, < 2.3
django-sekizai django-sekizai
django-extensions >= 3.1.0
inflect inflect
autobahn >= 17.9.3 autobahn >= 17.9.3
lunr == 0.5.6 lunr == 0.5.6
ipython >= 7.19.0
jupyter == 1.0.0
# try to resolve dependency issue in py3.7 # try to resolve dependency issue in py3.7
attrs >= 19.2.0 attrs >= 19.2.0

View file

@ -14,3 +14,8 @@ service_identity >= 18.1.0
# AWS-storage contrib # AWS-storage contrib
boto3 >= 1.4.4 boto3 >= 1.4.4
botocore >= 1.15 botocore >= 1.15
# Jupyter Notebook support
jupyter >= 1.0.0
ipython >= 7.19.0
django-extensions >= 3.1.0