Metadata-Version: 2.4
Name: platformstatusdb
Version: 0.3.0
License: MIT
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
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
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: django
Requires-Dist: networkx
Requires-Dist: pytz
Requires-Dist: PyYAML
Provides-Extra: dev
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: invoke; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: numpy; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-django; extra == "dev"
Requires-Dist: python-docs-theme; extra == "dev"
Requires-Dist: safety; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: tox; extra == "dev"
Dynamic: license-file

# Platform Status DB

A django implementation to meet the needs (implement the interface) for the PythonLanOrchestrator, i.e. a database managing process logging, container locations, etc.

## Features

Track and shows the status of a robotic platform matching the requirements of the [laborchestrator](https://gitlab.com/OpenLabAutomation/lab-automation-packages/laborchestrator)

## Installation
1. clone the repo:
``` bash
git clone https://gitlab.com/OpenLabAutomation/lab-automation-packages/platform_status_db.git
```
2. install:
``` bash
pip install -e platform_status_db/.
```
3. apply migrations (you might nee python3 or python3.12 depending on your environment)
``` bash
python src/platform_status_db/manage.py makemigrations
python src/platform_status_db/manage.py migrate
python src/platform_status_db/manage.py createsuperuser
```

## Usage:
1. start the database server
``` bash
run_status_db
```
2. See the admin interface here
[http://127.0.0.1:8000/admin/](http://127.0.0.1:8000/admin/)
3. See client interface here:
[http://127.0.0.1:8000/job_logs/](http://127.0.0.1:8000/job_logs/)

### DISCLAIMER

Running the database with way is not intended for production by django. But since this project is designed for use in internal networks this should pose no additional security risks. 

## Documentation

The Documentation can be found here: [documentaton site](https://openlabautomation.gitlab.io/-/lab-automation-packages/platform_status_db/-/jobs/11041767663/artifacts/public/index.html)


## Credits

This package was created with Cookiecutter* and the `opensource/templates/cookiecutter-pypackage`* project template.

[Cookiecutter](https://github.com/audreyr/cookiecutter )
[opensource/templates/cookiecutter-pypackage](https://gitlab.com/opensourcelab/software-dev/cookiecutter-pypackage) 
