****************************
Introduction to Django-Valem
****************************
Django-Valem is a collection of Django apps defining data models for parsing,
validation, manipulation and interpretation of chemical reactions, formulas, and
quantum states.
The ``django-valem`` apps package is based around PyValem_.
Installation:
=============
The ``django-valem`` apps can be installed either from PyPI_ using pip
.. code-block:: bash
python3 -m pip install django-valem
or from the source by running from the project source directory
.. code-block:: bash
python3 -m pip install .
Configuration:
==============
The ``django-valem`` apps can be added to any Django project by adding the following
apps into the ``INSTALLED_APPS`` list in the ``settings.py`` of the project:
.. code-block:: python
INSTALLED_APPS = [
...
"rp", # App handling species and their states
"rxn", # App handling chemical reactions between species (rp.RP instances)
"ds", # App handling datasets attached to rxn.Reaction instances
"refs", # App handling references for ds.ReactionDataSet subclasses instances
]
For Developers:
===============
It goes without saying that any development should be done in a clean virtual
environment.
After cloning or forking the project from its GitHub_ page, ``django-valem`` might be
installed into the virtual environment in editable mode with
.. code-block:: bash
pip install -e .[dev]
or on zsh:
.. code-block:: zsh
pip install -e .'[dev]'
The ``[dev]`` extra installs (apart from the package dependencies) also several
development-related packages, such as ``black``, ``ipython``, or ``django`` itself.
The tests can then be executed by running (from the project root directory)
.. code-block:: bash
python runtests.py
The project does not have ``requirements.txt`` by design, all the package dependencies
are rather handled by ``setup.py``.
The package needs to be installed to run the tests, which grants the testing process
another layer of usefulness.
The project code is formatted by ``black``.
Always make sure to format your code before submitting a pull request, by running
``black`` on all your python files, or ``black .`` from the project source directory.
If the ``rp.models.py``, or ``rxn.models.py`` are changed, the ``makemigrations.py``
script needs to be run to make migrations for the apps, before the apps are pushed to
master, or published to PyPI.
.. _GitHub: https://github.com/xnx/django-valem
.. _PyPI: https://pypi.org/project/django-valem
.. _PyValem: https://github.com/xnx/pyvalem
Raw data
{
"_id": null,
"home_page": "https://github.com/xnx/django-valem",
"name": "django-valem",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "django,chemistry,formula,species,state,reaction",
"author": "Christian Hill",
"author_email": "ch.hill@iaea.org",
"download_url": "https://files.pythonhosted.org/packages/96/43/68b64d4933d8c7ba96efb89a237d50d414f1f14e9d5550c6eea9b14a06a5/django-valem-0.1.14.tar.gz",
"platform": null,
"description": "****************************\nIntroduction to Django-Valem\n****************************\n\n\nDjango-Valem is a collection of Django apps defining data models for parsing,\nvalidation, manipulation and interpretation of chemical reactions, formulas, and\nquantum states.\nThe ``django-valem`` apps package is based around PyValem_.\n\n\n\nInstallation:\n=============\nThe ``django-valem`` apps can be installed either from PyPI_ using pip\n\n.. code-block:: bash\n\n python3 -m pip install django-valem\n\n\nor from the source by running from the project source directory\n\n.. code-block:: bash\n\n python3 -m pip install .\n\n\nConfiguration:\n==============\nThe ``django-valem`` apps can be added to any Django project by adding the following\napps into the ``INSTALLED_APPS`` list in the ``settings.py`` of the project:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n ...\n\n \"rp\", # App handling species and their states\n \"rxn\", # App handling chemical reactions between species (rp.RP instances)\n \"ds\", # App handling datasets attached to rxn.Reaction instances\n \"refs\", # App handling references for ds.ReactionDataSet subclasses instances\n ]\n\n\nFor Developers:\n===============\nIt goes without saying that any development should be done in a clean virtual\nenvironment.\nAfter cloning or forking the project from its GitHub_ page, ``django-valem`` might be\ninstalled into the virtual environment in editable mode with\n\n.. code-block:: bash\n\n pip install -e .[dev]\n\nor on zsh:\n\n.. code-block:: zsh\n\n pip install -e .'[dev]'\n\nThe ``[dev]`` extra installs (apart from the package dependencies) also several\ndevelopment-related packages, such as ``black``, ``ipython``, or ``django`` itself.\nThe tests can then be executed by running (from the project root directory)\n\n.. code-block:: bash\n\n python runtests.py\n\nThe project does not have ``requirements.txt`` by design, all the package dependencies\nare rather handled by ``setup.py``.\nThe package needs to be installed to run the tests, which grants the testing process\nanother layer of usefulness.\n\nThe project code is formatted by ``black``.\nAlways make sure to format your code before submitting a pull request, by running\n``black`` on all your python files, or ``black .`` from the project source directory.\n\nIf the ``rp.models.py``, or ``rxn.models.py`` are changed, the ``makemigrations.py``\nscript needs to be run to make migrations for the apps, before the apps are pushed to\nmaster, or published to PyPI.\n\n\n.. _GitHub: https://github.com/xnx/django-valem\n.. _PyPI: https://pypi.org/project/django-valem\n.. _PyValem: https://github.com/xnx/pyvalem\n",
"bugtrack_url": null,
"license": "",
"summary": "A collection of Django apps defining data models for managing chemical species, reactions and datasets.",
"version": "0.1.14",
"project_urls": {
"Bug Reports": "https://github.com/xnx/django-valem/issues",
"Homepage": "https://github.com/xnx/django-valem"
},
"split_keywords": [
"django",
"chemistry",
"formula",
"species",
"state",
"reaction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5dfc091be46e21a12692fd14c273344085eab7148fee59509df407597c860dd2",
"md5": "9a48b29e35198e24aeee43f48db6fa8b",
"sha256": "451c7ea3ffbc3316506c1ac9a55be8a9b3b06672047422118bace7007ac82527"
},
"downloads": -1,
"filename": "django_valem-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a48b29e35198e24aeee43f48db6fa8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16759,
"upload_time": "2023-10-18T13:10:09",
"upload_time_iso_8601": "2023-10-18T13:10:09.759293Z",
"url": "https://files.pythonhosted.org/packages/5d/fc/091be46e21a12692fd14c273344085eab7148fee59509df407597c860dd2/django_valem-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "964368b64d4933d8c7ba96efb89a237d50d414f1f14e9d5550c6eea9b14a06a5",
"md5": "a7601ff1167af397bf3bf92a2e1f3b30",
"sha256": "4f0c1acaa3f721020dc723b201bbe97285cc3bf44211d8b77295c447998ab655"
},
"downloads": -1,
"filename": "django-valem-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "a7601ff1167af397bf3bf92a2e1f3b30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18859,
"upload_time": "2023-10-18T13:10:11",
"upload_time_iso_8601": "2023-10-18T13:10:11.445427Z",
"url": "https://files.pythonhosted.org/packages/96/43/68b64d4933d8c7ba96efb89a237d50d414f1f14e9d5550c6eea9b14a06a5/django-valem-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-18 13:10:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xnx",
"github_project": "django-valem",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-valem"
}
JSON
