Skip to content

README.md

Latest commit

 

History

History
63 lines (39 loc) · 2.06 KB

README.md

File metadata and controls

63 lines (39 loc) · 2.06 KB

MQP-Database-Access

Documentation

Overview

MQP-Database-Access is the Python database access package for the Munich Quantum Portal (MQP) Dashboard and part of the Munich Quantum Software Stack (MQSS).

It provides ORM-backed data access modules for domain entities such as users, jobs, resources, budgets, tokens, time slots, feedback, and status handling.

Features

  • Python package: bqp_database_access
  • Database access logic built on Pony ORM
  • Support for testing/local SQLite and PostgreSQL-backed usage
  • Utility scripts for CSV import/export and SQL time-slot insertion

Getting Started

  1. Install PDM.
  2. Clone this repository.
  3. Install dependencies and developer tools:
git clone https://github.com/Munich-Quantum-Software-Stack/MQP-Database-Access.git
cd MQP-Database-Access
pdm install

Environment Variables

The package and test setup rely on the environment variables.

Use .env.example as a template for local configuration, then set environment-specific secret values before running tests or integrations.

Utility Scripts

  • scripts/import_from_csv.py
  • scripts/export_to_csv.py
  • scripts/insert_time_slot.sql
  • scripts/restricted_resources_to_usergroup.json

Review and adapt script configuration (for paths, credentials, and hosts) before use in your environment.

Security Notes

  • Never commit .env files, database passwords, peppers, tokens, or private keys.
  • Treat QUANTUM_DB_PASS, QUANTUM_DB_PEPPER, and QUANTUM_DB_TOKEN_PEPPER as secrets.
  • Use different secret values for local testing and production.
  • Rotate credentials and tokens according to your organization’s security policy.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md.

Code of Conduct

Please review CODE_OF_CONDUCT.md.

License

This project is licensed under the terms in LICENSE.