Built with Flask et SQLAlchemy, Quam Facere provides role-based access control for managing complex IT operations across teams with real-time execution tracking and document export capabilities.
Construit avec Flask et SQLAlchemy, Quam Facere fournit un contrôle d'accès basé sur les rôles pour la gestion d'opérations IT complexes à travers les équipes avec un suivi d'exécution en temps réel et des capacités d'exportation de documents.
Quam Facere Features - IT Procedure Management
Fonctionnalités Quam Facere - Gestion Procédures IT
Core Functionality
Fonctionnalités Clés
User Authentication & Authorization
Authentification & Autorisation Utilisateur
Secure login system with role-based access control.
Système de connexion sécurisé avec contrôle d'accès basé sur les rôles.
Team Management
Gestion d'Équipe
Hierarchical team structure with permission-based access.
Structure d'équipe hiérarchique avec accès basé sur les permissions.
Procedure Management
Gestion de Procédures
Create, edit, and organize IT procedures with variables and conditional logic.
Créer, éditer et organiser des procédures IT avec des variables et une logique conditionnelle.
Operation Execution
Exécution d'Opérations
Real-time tracking of procedure execution and progress monitoring.
Suivi en temps réel de l'exécution des procédures et surveillance de la progression.
Document Export
Exportation de Documents
Generate documentation in multiple formats (Markdown, PDF, Docx, etc.).
Générer de la documentation dans plusieurs formats (Markdown, PDF, Docx, etc.).
Internationalization
Internationalisation
Multi-language support (English/French).
Support multilingue (Anglais/Français).
Category Organization
Organisation par Catégorie
Hierarchical categorization of procedures for easy management.
Catégorisation hiérarchique des procédures pour une gestion facile.
Different databases
Différentes bases de données
You can use all databases supported by SQL Alchemy (SQLite, MySQL, PostgreSQL).
Vous pouvez utiliser toutes les bases de données supportées par SQLAlchemy (SQLite, MySQL, PostgreSQL).
Advanced Features
Fonctionnalités Avancées
Variable Substitution
Substitution de Variables
Dynamic content generation with configurable parameters.
Génération de contenu dynamique avec des paramètres configurables.
Task Management
Gestion des Tâches
Break down procedures into individual, trackable steps.
Décomposer les procédures en étapes individuelles et traçables.
Conditional Logic
Logique Conditionnelle
Smart procedure execution based on conditions.
Exécution intelligente des procédures basée sur des conditions.
Operations Management
Gestion des Opérations
Monitor operation status and completion.
Surveiller le statut et l'achèvement des opérations.
Flexible Configuration
Configuration Flexible
Adaptable to different environments and server configurations.
Adaptable à différents environnements et configurations de serveur.
Quam Facere Architecture - Flask Python Application
Architecture Quam Facere - Application Flask Python
The application follows Flask's blueprint pattern with modular components:
L'application suit le modèle de "blueprint" de Flask avec des composants modulaires :
qf/
├── __init__.py # Package initialization and app factory
├── main.py # Core web interface and route handlers
├── auth.py # Authentication and user management
├── db_models.py # SQLAlchemy database models
├── languages.py # Internationalization support
└── exporters.py # Document generation and export functionality
Permission Levels
Niveaux de Permissions
| Role | Permissions | |
|---|---|---|
| Rôle | Permissions | |
| Admin |
|
|
| Team Leader |
|
|
| Editor |
|
|
| User |
|
|
Database Models
Modèles de Base de Données
The application uses the following SQLAlchemy database models:
L'application utilise les modèles de base de données SQLAlchemy suivants :
- User: System users with role-based permissions
- Utilisateur: Utilisateurs du système avec permissions basées sur les rôles
- Team: Organizational units for grouping users
- Équipe: Unités organisationnelles pour le regroupement des utilisateurs
- Category: Hierarchical organization of procedures
- Catégorie: Organisation hiérarchique des procédures
- Procedure: IT procedures with variables and tasks
- Procédure: Procédures IT avec variables et tâches
- Operation: Running instances of procedures
- Opération: Instances en cours d'exécution des procédures
- Variable: Configurable parameters for procedures
- Variable: Paramètres configurables pour les procédures
- Task: Individual steps within procedures
- Tâche: Étapes individuelles au sein des procédures
Quam Facere Installation - Flask Python Setup
Installation Quam Facere - Configuration Flask Python
Prerequisites
Prérequis
- Python 3.7+
- Python 3.7+
- pip package manager
- Gestionnaire de paquets pip
Quick Start with a Venv
Démarrage Rapide avec un Venv
git clone git.code.sf.net/p/quam-facere/code
cd code
# Unix/macOS
python3 -m venv venv
source venv/bin/activate
# Windows
python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt
# For development run
flask run
# For Gunicorn wsgi run
gunicorn -w 4 -b '0.0.0.0:5000' qf:appDeactivate Venv
Désactiver le Venv
deactivateQuam Facere Usage Guide - IT Procedure Management
Guide Utilisation Quam Facere - Gestion Procédures IT
Configuration
Configuration
The application supports various configuration options for different environments. Configure your database connection, secret keys, and other settings according to your deployment needs.
L'application prend en charge diverses options de configuration pour différents environnements. Configurez votre connexion à la base de données, vos clés secrètes et d'autres paramètres en fonction de vos besoins de déploiement.
Run Docker images
Exécuter les images Docker
Docker image is available for running the application here. For run theirselves, you need to create a directory, change propriatary to 5000:5000 and mount this volume on /etc/quam_facere on docker run.. This path contains the config.yaml (view samplehere)), the cert.pem and the key.pem files. You can create a other directory for a sqlite database, change propriatary to 5000:5000 and mount it on instance After this yun can run the docker by:
Une image Docker est disponible pour exécuter l'application ici. Pour les exécuter, vous devez créer un répertoir, changer le propriétaire en 5000:5000 et le monter comme volume /etc/quam_facere au lancement de l'image docker. Ce chemin contient les fichiers config.yaml (voir l'exemple ici), cert.pem et key.pem. Vous pouvez créer un autre répertoire pour la base de donnée sqlite, changer le propriétaire en 5000:5000 et mouter celui-ci sur instance Après cela, vous pouvez exécuter le docker par :
sudo docker load -i qf-v0.1.3.tar.gz
sudo docker run -p 443:5000 -v CONFIG_PATH:/etc/quam_facere -v INSTANCE_PATH:instance qfDevelopment
Développement
Project Structure
Structure du Projet
The application uses a modular architecture with clear separation of concerns:
L'application utilise une architecture modulaire avec une séparation claire des préoccupations :
- Authentication: Handled by `auth.py` with Flask-Login integration
- Authentification: Gérée par `auth.py` avec l'intégration Flask-Login
- Database: SQLAlchemy models in `db_models.py`
- Base de Données: Modèles SQLAlchemy dans `db_models.py`
- Web Interface: Route handlers and templates in `main.py`
- Interface Web: Gestionnaires de routes et modèles dans `main.py`
- Internationalization: Language support in `languages.py`
- Internationalisation: Support linguistique dans `languages.py`
- Export Functions: Document generation in `exporters.py`
- Fonctions d'Exportation: Génération de documents dans `exporters.py`
Contributing
Contribuer
- Fork the repository
- Forker le dépôt
- Create a feature branch
- Créer une branche de fonctionnalité
- Make your changes
- Apporter vos modifications
- Test thoroughly
- Tester minutieusement
- Submit a pull request
- Soumettre une pull request
Quam Facere Use Cases - IT Operations & DevOps
Cas d'utilisation Quam Facere - Opérations IT & DevOps
IT Operations Teams
Équipes d'opérations IT
Standardize and track IT procedures across teams.
Standardiser et suivre les procédures IT à travers les équipes.
System Administration
Administration Système
Document and execute server maintenance procedures.
Documenter et exécuter les procédures de maintenance des serveurs.
DevOps Workflows
Flux de Travail DevOps
Manage deployment and configuration procedures.
Gérer les procédures de déploiement et de configuration.
Compliance
Conformité
Maintain audit trails of IT operations and procedures.
Maintenir des pistes d'audit des opérations et procédures IT.
Training
Formation
Provide structured procedures for team onboarding.
Fournir des procédures structurées pour l'intégration des équipes.
Demonstration
Démonstration
You can test Quam Facere here.
Vous pouvez tester Quam Facere ici.
License
Licence
This project is hosted on CodeBerg at: https://codeberg.org/spn109/Quam_Facere
Ce projet est hébergé sur CodeBerg à : https://codeberg.org/spn109/Quam_Facere
Support
Support
For issues, feature requests, or contributions, please use the project's issue tracker on CodeBerg.
Pour les problèmes, les demandes de fonctionnalités ou les contributions, veuillez utiliser le traqueur de problèmes du projet sur CodeBerg.
Pricing & Support
Tarifs & Support
Individuals
Particuliers
Full access to all features for personal use
Accès complet à toutes les fonctionnalités pour usage personnel
Support with Donation Soutenir par DonCompanies
Entreprises
Professional support and priority updates
Support professionnel et mises à jour prioritaires
Contact Me Me ContacterPublic Services & NGOs
Service Public & Associations
Special pricing for public institutions and non-profit organizations
Tarification spéciale pour les institutions publiques et associations
Contact Me Me Contacter