Skip to main content

A database application to manage lab resources.

Project description

Python Pytest pylint pylint pylint

Labbase2

Labbase2 is a database application written in Python using the Flask web framework. It is designed to help manage lab resources in a centralized and efficient way.

This project is a complete rewrite of the original Labbase and includes major improvements in usability, code quality, and maintainability.


🚀 Installation

Install the labbase2 package directly from PyPI:

pip install labbase2

Labbase2 is an installable Flask application. After installation, you can create a dedicated folder for your app instance. The folder typically contains:

project_folder/
├── upload/           # Folder for uploaded files
├── labbase2.db       # SQLite database (created on first run)
├── log.log           # Log file (created on first run)
└── main.py           # Script to start the app

⚙️ Configuration

At the very least, a secret ky should be configured, either through a config file or via the config_dict argument of create_app.

🧪 Example main.py

Here's a minimal setup to launch the app with Flask's built-in development server:

main.py

import logging

from labbase2 import create_app
from pathlib import Path
from logging.config import dictConfig


if __name__ == "__main__":

    dictConfig(
        {
            "version": 1,
            "formatters": {
                "default": {
                    "()": "labbase2.logging.RequestFormatter",
                    "format": "[%(asctime)s] %(levelname)-7s in %(module)-10s: [%(user)s] %(message)s",
                }
            },
            "handlers": {
                "wsgi": {
                    "class": "logging.StreamHandler",
                    "stream": "ext://flask.logging.wsgi_errors_stream",
                    "formatter": "default",
                },
                "file": {
                    "class": "logging.FileHandler",
                    "level": "DEBUG",
                    "filename": Path("instance", "log.log"),
                    "mode": "w",
                    "formatter": "default",
                },
            },
            "root": {"level": "DEBUG", "handlers": ["wsgi", "file"]},
        }
    )

    # Prevent 'werkzeug' from logging every single request.
    logger_werkz = logging.getLogger("werkzeug")
    logger_werkz.level = logging.ERROR

    # Configure the app.
    app = create_app(config_dict={"SECRET_KEY": "645588a195c5bbd"})

    app.run()

Start the app by running:

python main.py

The database (labbase2.db) and log file (log.log) will be created automatically on first run.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Third-Party Libraries

This project uses the following third-party libraries:

The above libraries are included locally in this repository or via CDNs. If included locally, their original license files are included in the respective folders.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

labbase2-0.3.0.tar.gz (313.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labbase2-0.3.0-py3-none-any.whl (396.8 kB view details)

Uploaded Python 3

File details

Details for the file labbase2-0.3.0.tar.gz.

File metadata

  • Download URL: labbase2-0.3.0.tar.gz
  • Upload date:
  • Size: 313.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for labbase2-0.3.0.tar.gz
Algorithm Hash digest
SHA256 821b30d22d8608e86f5f67d962d64c5504092963a0dff5de99c47a07222bb3d2
MD5 c9ed8194b9cbb0933e31506c00de569b
BLAKE2b-256 d74fa1cb10c926c36630c3a4d578944e706d3a0e5fa4078c026f2dd804f1b16d

See more details on using hashes here.

File details

Details for the file labbase2-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: labbase2-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 396.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for labbase2-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c8a572c1fc2e0c82c34243b926951ead1d5821be1b6f171f2a244545433fbae
MD5 85e78a588452fdeb5459f994e6b3d93b
BLAKE2b-256 4df0a56fe21506bad6324bd7d09b613d30bbd7bbf00f94ce63552c2309531029

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page