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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for labbase2-0.2.1.tar.gz
Algorithm Hash digest
SHA256 8672b3b5eb91580b8fbf52ebbd8b1b62e0f124c5c7badfb624b323fc643e04a4
MD5 c98ffaafc6cc5159051c2dab8f718636
BLAKE2b-256 73e5ccd0f79607ece03e72b996b7c43ac9ebf52369c75da926d0d406d17ff86a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: labbase2-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d0f8cac0915f593846919131499e60a8ae55460a7eefd8318ca7891f9f60e0b
MD5 2eaf2b10e4a604a894bf67ce5472cc97
BLAKE2b-256 983f04a111d02db687aaea75066f8485ad7c49f04f34ea5986c57c9f277a2b9d

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