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.2.2.tar.gz (310.1 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.2.2-py3-none-any.whl (391.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for labbase2-0.2.2.tar.gz
Algorithm Hash digest
SHA256 10a5de41ee6786a8a669ca7d557ccbb26069f35429a7322828a56bfd2d1b0c9e
MD5 2cdd31aabc5fcf13ae17cbcb12c2110a
BLAKE2b-256 134a016c37e4f9388b74188e5963ee9d42c6bcb3d91dea01d2f942bf32315dd5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for labbase2-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b11e220f46e307766e86f54944d936e8915095cf9ddabdb992f38b09519668d6
MD5 d0cc39e9672c58f508168f11805c3d4e
BLAKE2b-256 3744eca4332de068660161eaea2e68b5c72ca8e5c3d0b5f304b85adc4cf97f13

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