Welcome to Mathics-Django
=========================
|CI Status| |Pypi Installs| |Latest Version| |Supported Python Versions|
|Packaging status|
This is the Django front-end to `Mathics3 <https://mathics.org>`_.
.. contents::
:depth: 1
:local:
Features:
---------
* Extensive online documentation
* Integrated graphics, via `three.js <https://threejs.org>`_, and MathML mathematics output
* Notebook-like sessions
Note: in the future we intend to also proved a Jupyter-like interface.
ScreenShot
----------
mathicsserver: a Django-based Web interface
+++++++++++++++++++++++++++++++++++++++++++
|mathicssserver|
Installing
----------
This package needs a working `Mathics3`, the core engine, installed as well as a recent
version of Django. For Django, you will need mysql or mariadb
installed, since that is where worksheets are stored.
See the `Installing Mathics <https://mathics-development-guide.readthedocs.io/en/latest/installing.html>`_ for instructions on installing Mathics3.
If you are a novice at installing Python packages, consider using either a pre-built OS package if available under "Packaging status" above,
or the `mathics docker image <https://hub.docker.com/r/mathicsorg/mathics>`_.
Ubuntu/Debian Specific OS dependent packages
++++++++++++++++++++++++++++++++++++++++++++
On Ubuntu or Debian::
apt install default-libmysqlclient-dev.
Install from PyPI
+++++++++++++++++
Once Mathics3 is installed, run::
pip install Mathics-Django
Install from Github source
++++++++++++++++++++++++++
From the place root directory that github was checked out::
make install
Running
-------
This is a Django project, so Dango's `manage.py <https://docs.djangoproject.com/en/3.2/ref/django-admin/>`_ script used.
A simple way to start Mathics Django when GNU make is installed (which is the case on most POSIX systems):
::
make runserver
Underneath this runs the Python program ``manage.py`` in ``mathics_django`` directory.
To get a list of the available commands, type ``python
mathics_django/manage.py help``. To get help on a specific command
give that command at the end. For example two commands that are useful
are the ``runserver`` and ``testserver`` commands. ``python
mathics_django/manage.py help runserver`` will show options in running
the Django server.
Once the server is started you will see a URL listed that lookss like this::
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
Point your browser to the URL listed above. Here it is ``http://127.0.0.1:8000``
Environment Variables
+++++++++++++++++++++
There are two special environment variables of note which controls
where the Mathics database is located. This database is saves
authentication and worksheet information.
By default the database used is ``DATADIR + mathics.sqlite`` where
``DATADIR`` is under ``AppData/Python/Mathics/`` for MS-Windows and
``~/.local/var/mathics/`` for all others. If you want to specify your own database file set
environment variable ``MATHICS_DJANGO_DB_PATH``.
If you just want to set the ``mathics.sqlite`` portion, you can use
the environment variable ``MATHICS_DJANGO_DB``.
Information for the online-documentation comes from one of two places,
``DOC_USER_HTML_DATA_PATH`` if that exists and
``DOC_SYSTEM_HTML_DATA_PATH`` as fallback if that doesn't exist. The
latter is created when the package is built. The former allows for the
user or developer to update this information. In the future it will
take into account plugins that have been added.
Contributing
------------
Please feel encouraged to contribute to Mathics3! Create your own fork, make the desired changes, commit, and make a pull request.
License
-------
Mathics-Django is released under the GNU General Public License Version 3 (GPL3).
.. |mathicssserver| image:: https://mathics.org/images/mathicsserver.png
.. |Latest Version| image:: https://badge.fury.io/py/Mathics-Django.svg
:target: https://badge.fury.io/py/Mathics-Django
.. |Supported Python Versions| image:: https://img.shields.io/pypi/pyversions/Mathics-Django.svg
.. |CI status| image:: https://github.com/Mathics3/mathics-django/workflows/Mathics-Django%20(ubuntu)/badge.svg
:target: https://github.com/Mathics3/mathics-django/actions
.. |Packaging status| image:: https://repology.org/badge/vertical-allrepos/mathics-django.svg
:target: https://repology.org/project/mathics-django/versions
.. |Pypi Installs| image:: https://pepy.tech/badge/mathics-django
Raw data
{
"_id": null,
"home_page": "https://mathics.org/",
"name": "Mathics-Django",
"maintainer": "Mathics3 Group",
"docs_url": null,
"requires_python": null,
"maintainer_email": "mathics-devel@googlegroups.com",
"keywords": "Mathematica, Wolfram, Interpreter, Shell, Math, CAS",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/17/bf/e532b15a2f07a60ffe29a95447b70d80654376b865fbe7caa9a319b66207/Mathics-Django-7.0.0.tar.gz",
"platform": null,
"description": "Welcome to Mathics-Django\n=========================\n\n|CI Status| |Pypi Installs| |Latest Version| |Supported Python Versions|\n\n|Packaging status|\n\nThis is the Django front-end to `Mathics3 <https://mathics.org>`_.\n\n.. contents::\n :depth: 1\n :local:\n\nFeatures:\n---------\n\n* Extensive online documentation\n* Integrated graphics, via `three.js <https://threejs.org>`_, and MathML mathematics output\n* Notebook-like sessions\n\nNote: in the future we intend to also proved a Jupyter-like interface.\n\nScreenShot\n----------\n\nmathicsserver: a Django-based Web interface\n+++++++++++++++++++++++++++++++++++++++++++\n\n|mathicssserver|\n\n\nInstalling\n----------\n\nThis package needs a working `Mathics3`, the core engine, installed as well as a recent\nversion of Django. For Django, you will need mysql or mariadb\ninstalled, since that is where worksheets are stored.\n\nSee the `Installing Mathics <https://mathics-development-guide.readthedocs.io/en/latest/installing.html>`_ for instructions on installing Mathics3.\n\nIf you are a novice at installing Python packages, consider using either a pre-built OS package if available under \"Packaging status\" above,\nor the `mathics docker image <https://hub.docker.com/r/mathicsorg/mathics>`_.\n\n\nUbuntu/Debian Specific OS dependent packages\n++++++++++++++++++++++++++++++++++++++++++++\n\nOn Ubuntu or Debian::\n\n apt install default-libmysqlclient-dev.\n\nInstall from PyPI\n+++++++++++++++++\n\nOnce Mathics3 is installed, run::\n\n pip install Mathics-Django\n\n\nInstall from Github source\n++++++++++++++++++++++++++\n\nFrom the place root directory that github was checked out::\n\n make install\n\n\nRunning\n-------\n\nThis is a Django project, so Dango's `manage.py <https://docs.djangoproject.com/en/3.2/ref/django-admin/>`_ script used.\n\nA simple way to start Mathics Django when GNU make is installed (which is the case on most POSIX systems):\n\n::\n\n make runserver\n\nUnderneath this runs the Python program ``manage.py`` in ``mathics_django`` directory.\n\nTo get a list of the available commands, type ``python\nmathics_django/manage.py help``. To get help on a specific command\ngive that command at the end. For example two commands that are useful\nare the ``runserver`` and ``testserver`` commands. ``python\nmathics_django/manage.py help runserver`` will show options in running\nthe Django server.\n\nOnce the server is started you will see a URL listed that lookss like this::\n\n Starting development server at http://127.0.0.1:8000/\n Quit the server with CONTROL-C.\n\nPoint your browser to the URL listed above. Here it is ``http://127.0.0.1:8000``\n\nEnvironment Variables\n+++++++++++++++++++++\n\nThere are two special environment variables of note which controls\nwhere the Mathics database is located. This database is saves\nauthentication and worksheet information.\n\nBy default the database used is ``DATADIR + mathics.sqlite`` where\n``DATADIR`` is under ``AppData/Python/Mathics/`` for MS-Windows and\n``~/.local/var/mathics/`` for all others. If you want to specify your own database file set\nenvironment variable ``MATHICS_DJANGO_DB_PATH``.\n\nIf you just want to set the ``mathics.sqlite`` portion, you can use\nthe environment variable ``MATHICS_DJANGO_DB``.\n\nInformation for the online-documentation comes from one of two places,\n``DOC_USER_HTML_DATA_PATH`` if that exists and\n``DOC_SYSTEM_HTML_DATA_PATH`` as fallback if that doesn't exist. The\nlatter is created when the package is built. The former allows for the\nuser or developer to update this information. In the future it will\ntake into account plugins that have been added.\n\n\nContributing\n------------\n\nPlease feel encouraged to contribute to Mathics3! Create your own fork, make the desired changes, commit, and make a pull request.\n\n\nLicense\n-------\n\nMathics-Django is released under the GNU General Public License Version 3 (GPL3).\n\n.. |mathicssserver| image:: https://mathics.org/images/mathicsserver.png\n.. |Latest Version| image:: https://badge.fury.io/py/Mathics-Django.svg\n\t\t :target: https://badge.fury.io/py/Mathics-Django\n.. |Supported Python Versions| image:: https://img.shields.io/pypi/pyversions/Mathics-Django.svg\n.. |CI status| image:: https://github.com/Mathics3/mathics-django/workflows/Mathics-Django%20(ubuntu)/badge.svg\n\t\t :target: https://github.com/Mathics3/mathics-django/actions\n.. |Packaging status| image:: https://repology.org/badge/vertical-allrepos/mathics-django.svg\n\t\t\t :target: https://repology.org/project/mathics-django/versions\n.. |Pypi Installs| image:: https://pepy.tech/badge/mathics-django\n\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "A Django front end for Mathics3.",
"version": "7.0.0",
"project_urls": {
"Homepage": "https://mathics.org/"
},
"split_keywords": [
"mathematica",
" wolfram",
" interpreter",
" shell",
" math",
" cas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ad048805e69397add369c3d01fb683e9e1e3dca844f3200264f4d102372cd9b",
"md5": "aac626d37bcfb99eb9a3c25a38ebfbb0",
"sha256": "a6bf41ed5532756b0227479faeb7af3dd9d08cd397b5384c80cec56aabe48dfd"
},
"downloads": -1,
"filename": "Mathics_Django-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aac626d37bcfb99eb9a3c25a38ebfbb0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25353068,
"upload_time": "2024-08-09T20:37:13",
"upload_time_iso_8601": "2024-08-09T20:37:13.769949Z",
"url": "https://files.pythonhosted.org/packages/8a/d0/48805e69397add369c3d01fb683e9e1e3dca844f3200264f4d102372cd9b/Mathics_Django-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17bfe532b15a2f07a60ffe29a95447b70d80654376b865fbe7caa9a319b66207",
"md5": "083a2d3e2493735a11c15609c16dc7a7",
"sha256": "b1756bff76799f75c08c0c66741b2a12f3927bec462272d3182bc5d427c08c09"
},
"downloads": -1,
"filename": "Mathics-Django-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "083a2d3e2493735a11c15609c16dc7a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24130910,
"upload_time": "2024-08-09T20:37:17",
"upload_time_iso_8601": "2024-08-09T20:37:17.372854Z",
"url": "https://files.pythonhosted.org/packages/17/bf/e532b15a2f07a60ffe29a95447b70d80654376b865fbe7caa9a319b66207/Mathics-Django-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 20:37:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mathics-django"
}
JSON