Metadata-Version: 2.3
Name: lara_django_substances_store
Version: 0.2.90
Summary: 
Author: mark doerr
Author-email: mark doerr <mark.doerr@uni-greifswald.de>
License: GPLv3+
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: ==3.13.*
Project-URL: Documentation, https://larasuite.gitlab.io/lara_django_substances_store
Project-URL: Source, https://gitlab.com/larasuite/lara_django_substances_store
Project-URL: Bug Tracker, https://gitlab.com/larasuite/lara_django_substances_store/issues
Project-URL: Changelog, https://gitlab.com/larasuite/lara_django_substances_store/blob/main/CHANGELOG.md
Description-Content-Type: text/markdown

# LARA-django Substances Store

LARA python-django application for managing an inventory of chemical substances, polymers and mixtures.

## Installation

In the active LARA-django environment, install

    cd  lara_django_substances_store
    pip install .


Add "my_new_app" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        ' lara_django_substances_store',
    ]

Include the lara-django-app URLconf in your project urls.py like
this:

    path(' lara_django_substances_store', include('my_new_app.urls')),

Run 

    python manage.py makemigrations  lara_django_substances_store
    python manage.py migrate 
    
to create the my_new_app database models.


In case you like to test the app, please load the demo data:

Start the development server 

    lara-django-dev runserver

and visit

http://127.0.0.1:8000/admin/ 

to create some entries (you'll need the Admin app enabled).


## Environment variables

for development, please set

    export DJANGO_ALLOWED_HOSTS=localhost
    export DJANGO_SETTINGS_MODULE=lara_django.settings.devel

for production, please set 

    export DJANGO_SETTINGS_MODULE=lara_django.settings.production

if your media does not reside in the default media folder, please set
environment variable to 

    export DJANGO_MEDIA_PATH='path/to/my/media'

to use user defined fixtures, please set: :: export
    
    DJANGO_FIXTURE_PATH='path/to/user/fixtures'


Testing all applications

## Basic Commands

### Type checks

Running type checks with mypy:

    $ mypy lara_django_substances_store

### Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

    $ coverage run -m pytest
    $ coverage html
    $ open htmlcov/index.html

#### Running tests with pytest

    $ pytest


[![Built with Cookiecutter Django](https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter)](https://github.com/cookiecutter/cookiecutter-django/)
[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

License: GPLv3

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- markdownlint-disable -->
<!-- markdownlint-enable -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!