lecrapaud 0.20.0__py3-none-any.whl → 0.20.2__py3-none-any.whl

lecrapaud/feature_selection.py

@@ -73,18 +73,21 @@ def load_train_data(experiment_dir):
 
 
 class FeatureSelectionEngine:
-    def __init__(self, train, experiment, target_number, target_clf, **kwargs):
+    def __init__(self, train, experiment, target_number, **kwargs):
         self.experiment = experiment
         self.train = train
         self.target_number = target_number
-        self.target_clf = target_clf
+        
+        # Get all parameters from experiment context
+        self.target_clf = self.experiment.context.get("target_clf", [])
+        self.max_p_value_categorical = self.experiment.context.get("max_p_value_categorical", 0.05)
+        self.percentile = self.experiment.context.get("percentile", 20)
+        self.corr_threshold = self.experiment.context.get("corr_threshold", 80)
+        self.max_features = self.experiment.context.get("max_features", 50)
 
         self.target_type = (
             "classification" if self.target_number in self.target_clf else "regression"
         )
-        self.percentile = self.experiment.percentile
-        self.corr_threshold = self.experiment.corr_threshold
-        self.max_features = self.experiment.max_features
 
         self.experiment_dir = self.experiment.path
         self.experiment_id = self.experiment.id
@@ -274,6 +277,38 @@ class FeatureSelectionEngine:
         features_selected.drop_duplicates("features", inplace=True)
 
         features_selected_list = features_selected["features"].values.tolist()
+        
+        # Save ensemble features before correlation (aggregated features)
+        logger.info("Saving ensemble features before correlation...")
+        all_features_in_data = self.X.columns.tolist()
+        ensemble_rows = []
+        
+        # Add global rank for selected features
+        features_selected_with_global_rank = features_selected.copy()
+        features_selected_with_global_rank["global_rank"] = range(1, len(features_selected_with_global_rank) + 1)
+        
+        for feature in all_features_in_data:
+            feature_id = feature_map.get(feature)
+            if feature_id:
+                is_selected = feature in features_selected_list
+                global_rank = None
+                if is_selected:
+                    global_rank = features_selected_with_global_rank[
+                        features_selected_with_global_rank["features"] == feature
+                    ]["global_rank"].values[0]
+                
+                ensemble_rows.append({
+                    "feature_selection_id": feature_selection.id,
+                    "feature_id": feature_id,
+                    "method": "ensemble",
+                    "score": None,
+                    "pvalue": None,
+                    "support": 2 if is_selected else 0,  # 2 = in aggregated features
+                    "rank": global_rank,
+                    "training_time": 0,
+                })
+        
+        FeatureSelectionRank.bulk_upsert(rows=ensemble_rows)
 
         # analysis 1
         features_selected_by_every_methods = set(results[0]["features"].values.tolist())
@@ -302,12 +337,46 @@ class FeatureSelectionEngine:
             header=True,
             index_label="ID",
         )
+        
+        # Update support for features after correlation removal (before max)
+        logger.info("Updating ensemble features after correlation removal...")
+        for row in ensemble_rows:
+            feature = Feature.get(row["feature_id"]).name
+            if feature in features:
+                row["support"] = 1  # 1 = survived correlation removal
+        
         features = features[:max_features]
 
         # adding categorical features selected
         features += (
             categorical_features_selected if target_type == "classification" else []
         )
+        
+        # Final update for features after max limitation (final selection)
+        logger.info("Finalizing ensemble features with categorical features...")
+        for row in ensemble_rows:
+            feature = Feature.get(row["feature_id"]).name
+            if feature in features and row["support"] == 1:
+                row["support"] = 2  # 2 = in final selection
+        
+        # Add categorical features to ensemble if not already present
+        if target_type == "classification":
+            for cat_feature in categorical_features_selected:
+                feature_id = feature_map.get(cat_feature)
+                if feature_id and not any(row["feature_id"] == feature_id for row in ensemble_rows):
+                    ensemble_rows.append({
+                        "feature_selection_id": feature_selection.id,
+                        "feature_id": feature_id,
+                        "method": "ensemble",
+                        "score": None,
+                        "pvalue": None,
+                        "support": 2,  # 2 = in final selection (categorical)
+                        "rank": None,  # No rank for categorical features added at the end
+                        "training_time": 0,
+                    })
+        
+        # Re-save all ensemble data with updated support values
+        FeatureSelectionRank.bulk_upsert(rows=ensemble_rows)
         logger.debug(
             f"Final pre-selection: {len(features)} features below {corr_threshold}% out of {len(features_selected_list)} features, and rejected {len(features_correlated)} features, {100*len(features)/len(features_selected_list):.2f}% features selected"
         )
@@ -440,13 +509,18 @@ class FeatureSelectionEngine:
         feat_scores["features"] = X.columns
         feat_scores["rank"] = feat_scores["score"].rank(method="first", ascending=False)
         feat_scores["method"] = "Chi2"
+        
+        # Apply both percentile and p-value filtering
+        # Keep features that satisfy BOTH conditions: within percentile AND p-value < threshold
+        feat_scores["support"] = feat_scores["support"] & (feat_scores["pvalue"] <= self.max_p_value_categorical)
+        
         feat_scores.sort_values("rank", ascending=True, inplace=True)
         stop = time.time()
         training_time = timedelta(seconds=(stop - start)).total_seconds()
         feat_scores["training_time"] = training_time
 
         logger.debug(
-            f"Chi2 evaluation selected {feat_scores['support'].sum()} features in {training_time:.2f} seconds"
+            f"Chi2 evaluation selected {feat_scores['support'].sum()} features in {training_time:.2f} seconds (percentile={percentile}%, p-value<={self.max_p_value_categorical})"
         )
 
         feat_scores.to_csv(
@@ -803,33 +877,28 @@ class PreprocessModel:
         val,
         test,
         experiment,
-        target_numbers,
-        target_clf,
-        models_idx,
-        time_series,
-        max_timesteps,
-        group_column,
-        date_column,
         **kwargs,
     ):
         self.train = train
         self.val = val
         self.test = test
         self.experiment = experiment
-        self.target_numbers = target_numbers
-        self.target_clf = target_clf
-        self.models_idx = models_idx
-        self.time_series = time_series
-        self.max_timesteps = max_timesteps
-        self.group_column = group_column
-        self.date_column = date_column
+        
+        # Get all parameters from experiment context
+        self.target_numbers = self.experiment.context.get("target_numbers", [])
+        self.target_clf = self.experiment.context.get("target_clf", [])
+        self.models_idx = self.experiment.context.get("models_idx", [])
+        self.time_series = self.experiment.context.get("time_series", False)
+        self.max_timesteps = self.experiment.context.get("max_timesteps", 120)
+        self.group_column = self.experiment.context.get("group_column", None)
+        self.date_column = self.experiment.context.get("date_column", None)
 
         self.experiment_dir = experiment.path
         self.data_dir = f"{self.experiment_dir}/data"
         self.preprocessing_dir = f"{self.experiment_dir}/preprocessing"
 
         self.all_features = experiment.get_all_features(
-            date_column=date_column, group_column=group_column
+            date_column=self.date_column, group_column=self.group_column
         )
 
     def run(self):

lecrapaud/model_selection.py

@@ -1017,24 +1017,24 @@ class ModelSelectionEngine:
         data,
         reshaped_data,
         target_number,
-        target_clf,
         experiment,
-        models_idx,
-        time_series,
-        date_column,
-        group_column,
-        target_clf_thresholds,
         **kwargs,
     ):
         self.data = data
         self.reshaped_data = reshaped_data
         self.target_number = target_number
         self.experiment = experiment
-        self.target_clf = target_clf
-        self.models_idx = models_idx
-        self.time_series = time_series
-        self.date_column = date_column
-        self.group_column = group_column
+
+        # Get all parameters from experiment context
+        context = self.experiment.context
+        self.target_clf = context.get("target_clf", [])
+        self.models_idx = context.get("models_idx", [])
+        self.time_series = context.get("time_series", False)
+        self.date_column = context.get("date_column", None)
+        self.group_column = context.get("group_column", None)
+
+        # Handle target_clf_thresholds
+        target_clf_thresholds = context.get("target_clf_thresholds", {})
         self.target_clf_thresholds = (
             target_clf_thresholds[target_number]
             if target_number in target_clf_thresholds.keys()
@@ -1056,25 +1056,19 @@ class ModelSelectionEngine:
         )
 
     # Main training function
-    def run(
-        self,
-        experiment_name,
-        perform_hyperopt=True,
-        number_of_trials=20,
-        perform_crossval=False,  # This controls CV during hyperopt, not after
-        plot=True,
-        clean_dir=False,  # TODO: This has been unused because now feature_selection is in the target directory
-        preserve_model=True,
-        best_params=None,
-    ):
+    def run(self, best_params=None):
         """
         Selects the best models based on a target variable, optionally performing hyperparameter optimization
         and cross-validation, and manages outputs in a session-specific directory.
         """
-        self.experiment_name = experiment_name
-        self.plot = plot
-        self.number_of_trials = number_of_trials
-        self.perform_crossval = perform_crossval
+        # Get all parameters from experiment context
+        context = self.experiment.context
+        self.experiment_name = context.get("experiment_name", "")
+        self.plot = context.get("plot", True)
+        self.number_of_trials = context.get("number_of_trials", 20)
+        self.perform_crossval = context.get("perform_crossval", False)
+        self.preserve_model = context.get("preserve_model", True)
+        self.perform_hyperopt = context.get("perform_hyperopt", True)
 
         if self.experiment_id is None:
             raise ValueError("Please provide a experiment.")
@@ -1141,13 +1135,13 @@ class ModelSelectionEngine:
             self.results_dir = f"{self.target_dir}/{model_name}"
             if not os.path.exists(f"{self.results_dir}"):
                 os.makedirs(f"{self.results_dir}")
-            elif preserve_model and contains_best(self.results_dir):
+            elif self.preserve_model and contains_best(self.results_dir):
                 continue
-            elif perform_hyperopt:
+            elif self.perform_hyperopt:
                 clean_directory(self.results_dir)
 
             logger.info(
-                f"{experiment_name} - Training a {model_name} at {datetime.now()} for TARGET_{self.target_number}"
+                f"{self.experiment_name} - Training a {model_name} at {datetime.now()} for TARGET_{self.target_number}"
             )
 
             # Getting data
@@ -1204,7 +1198,7 @@ class ModelSelectionEngine:
 
             # Tuning hyperparameters
             start = time.time()
-            if perform_hyperopt:
+            if self.perform_hyperopt:
                 model_best_params = self.hyperoptimize(
                     x_train, y_train, x_val, y_val, model
                 )

lecrapaud/utils.py

@@ -11,7 +11,7 @@ import re
 import string
 
 from lecrapaud.directories import logger_dir
-from lecrapaud.config import LOGGING_LEVEL, PYTHON_ENV, LECRAPAUD_LOCAL
+from lecrapaud.config import LOGGING_LEVEL, PYTHON_ENV
 
 
 _LECRAPAUD_LOGGER_ALREADY_CONFIGURED = False
@@ -237,7 +237,7 @@ def serialize_for_json(obj):
     import numpy as np
     from datetime import datetime, date
     import pandas as pd
-    
+
     # Handle NumPy types
     if isinstance(obj, (np.integer, np.int64, np.int32, np.int16)):
         return int(obj)
@@ -247,11 +247,11 @@ def serialize_for_json(obj):
         return obj.tolist()
     elif isinstance(obj, np.bool_):
         return bool(obj)
-    
+
     # Handle datetime types
     elif isinstance(obj, (datetime, date, pd.Timestamp)):
         return obj.isoformat()
-    
+
     # Handle basic Python types
     elif isinstance(obj, (str, int, float, bool, type(None))):
         return obj

lecrapaud-0.20.2.dist-info/METADATA

@@ -0,0 +1,344 @@
+Metadata-Version: 2.4
+Name: lecrapaud
+Version: 0.20.2
+Summary: Framework for machine and deep learning, with regression, classification and time series analysis
+License: Apache License
+License-File: LICENSE
+Author: Pierre H. Gallet
+Requires-Python: ==3.12.*
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: catboost (>=1.2.8)
+Requires-Dist: category-encoders (>=2.8.1)
+Requires-Dist: celery (>=5.5.3)
+Requires-Dist: ftfy (>=6.3.1)
+Requires-Dist: joblib (>=1.5.1)
+Requires-Dist: keras (>=3.10.0)
+Requires-Dist: lightgbm (>=4.6.0)
+Requires-Dist: matplotlib (>=3.10.3)
+Requires-Dist: mlxtend (>=0.23.4)
+Requires-Dist: numpy (>=2.1.3)
+Requires-Dist: openai (>=1.88.0)
+Requires-Dist: pandas (>=2.3.0)
+Requires-Dist: pydantic (>=2.9.2)
+Requires-Dist: python-dotenv (>=1.1.0)
+Requires-Dist: scikit-learn (>=1.6.1)
+Requires-Dist: scipy (<1.14.0)
+Requires-Dist: seaborn (>=0.13.2)
+Requires-Dist: sqlalchemy (>=2.0.41)
+Requires-Dist: tensorboardx (>=2.6.4)
+Requires-Dist: tensorflow (>=2.19.0)
+Requires-Dist: tiktoken (>=0.9.0)
+Requires-Dist: tqdm (>=4.67.1)
+Requires-Dist: xgboost (>=3.0.2)
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<img src="https://s3.amazonaws.com/pix.iemoji.com/images/emoji/apple/ios-12/256/frog-face.png" width=120 alt="crapaud"/>
+
+## Welcome to LeCrapaud
+
+**An all-in-one machine learning framework**
+
+[![GitHub stars](https://img.shields.io/github/stars/pierregallet/lecrapaud.svg?style=flat&logo=github&colorB=blue&label=stars)](https://github.com/pierregallet/lecrapaud/stargazers)
+[![PyPI version](https://badge.fury.io/py/lecrapaud.svg)](https://badge.fury.io/py/lecrapaud)
+[![Python versions](https://img.shields.io/pypi/pyversions/lecrapaud.svg)](https://pypi.org/project/lecrapaud)
+[![License](https://img.shields.io/github/license/pierregallet/lecrapaud.svg)](https://github.com/pierregallet/lecrapaud/blob/main/LICENSE)
+[![codecov](https://codecov.io/gh/pierregallet/lecrapaud/branch/main/graph/badge.svg)](https://codecov.io/gh/pierregallet/lecrapaud)
+
+</div>
+
+## 🚀 Introduction
+
+LeCrapaud is a high-level Python library for end-to-end machine learning workflows on tabular data, with a focus on financial and stock datasets. It provides a simple API to handle feature engineering, model selection, training, and prediction, all in a reproducible and modular way.
+
+## ✨ Key Features
+
+- 🧩 Modular pipeline: Feature engineering, preprocessing, selection, and modeling as independent steps
+- 🤖 Automated model selection and hyperparameter optimization
+- 📊 Easy integration with pandas DataFrames
+- 🔬 Supports both regression and classification tasks
+- 🛠️ Simple API for both full pipeline and step-by-step usage
+- 📦 Ready for production and research workflows
+
+## ⚡ Quick Start
+
+
+### Install the package
+
+```sh
+pip install lecrapaud
+```
+
+### How it works
+
+This package provides a high-level API to manage experiments for feature engineering, model selection, and prediction on tabular data (e.g. stock data).
+
+### Typical workflow
+
+```python
+from lecrapaud import LeCrapaud
+
+# 1. Create the main app
+app = LeCrapaud(uri=uri)
+
+# 2. Define your experiment context (see your notebook or api.py for all options)
+context = {
+    "data": your_dataframe,
+    "columns_drop": [...],
+    "columns_date": [...],
+    # ... other config options
+}
+
+# 3. Create an experiment
+experiment = app.create_experiment(**context)
+
+# 4. Run the full training pipeline
+experiment.train(your_dataframe)
+
+# 5. Make predictions on new data
+predictions = experiment.predict(new_data)
+```
+
+### Database Configuration (Required)
+
+LeCrapaud requires access to a MySQL database to store experiments and results. You must either:
+
+- Pass a valid MySQL URI to the `LeCrapaud` constructor:
+  ```python
+  app = LeCrapaud(uri="mysql+pymysql://user:password@host:port/dbname")
+  ```
+- **OR** set the following environment variables before using the package:
+  - `DB_USER`, `DB_PASSWORD`, `DB_HOST`, `DB_PORT`, `DB_NAME`
+  - Or set `DB_URI` directly with your full connection string.
+
+If neither is provided, database operations will not work.
+
+### Using OpenAI Embeddings (Optional)
+
+If you want to use the `columns_pca` embedding feature (for advanced feature engineering), you must set the `OPENAI_API_KEY` environment variable with your OpenAI API key:
+
+```sh
+export OPENAI_API_KEY=sk-...
+```
+
+If this variable is not set, features relying on OpenAI embeddings will not be available.
+
+### Experiment Context Arguments
+
+The experiment context is a dictionary containing all configuration parameters for your ML pipeline. Parameters are stored in the experiment's database record and automatically retrieved when loading an existing experiment.
+
+#### Required Parameters
+
+| Parameter         | Type      | Description                                          | Example                |
+|-------------------|-----------|------------------------------------------------------|------------------------|
+| `data`           | DataFrame | Input dataset (required for new experiments only)    | `pd.DataFrame(...)`    |
+| `experiment_name`| str       | Unique name for the experiment                      | `'stock_prediction'`   |
+| `date_column`    | str       | Name of the date column (required for time series)  | `'DATE'`              |
+| `group_column`   | str       | Name of the group column (required for panel data)  | `'STOCK'`             |
+
+#### Feature Engineering Parameters
+
+| Parameter             | Type  | Default | Description                                                              |
+|-----------------------|-------|---------|--------------------------------------------------------------------------|
+| `columns_drop`        | list  | `[]`    | Columns to drop during feature engineering                              |
+| `columns_boolean`     | list  | `[]`    | Columns to convert to boolean features                                  |
+| `columns_date`        | list  | `[]`    | Date columns for cyclic encoding                                        |
+| `columns_te_groupby`  | list  | `[]`    | Groupby columns for target encoding                                     |
+| `columns_te_target`   | list  | `[]`    | Target columns for target encoding                                      |
+
+#### Preprocessing Parameters
+
+| Parameter               | Type  | Default | Description                                                           |
+|-------------------------|-------|---------|-----------------------------------------------------------------------|
+| `time_series`           | bool  | `False` | Whether data is time series                                          |
+| `val_size`              | float | `0.2`   | Validation set size (fraction)                                       |
+| `test_size`             | float | `0.2`   | Test set size (fraction)                                             |
+| `columns_pca`           | list  | `[]`    | Columns for PCA transformation                                       |
+| `pca_temporal`          | list  | `[]`    | Temporal PCA config (e.g., lag features)                            |
+| `pca_cross_sectional`   | list  | `[]`    | Cross-sectional PCA config (e.g., market regime)                    |
+| `columns_onehot`        | list  | `[]`    | Columns for one-hot encoding                                         |
+| `columns_binary`        | list  | `[]`    | Columns for binary encoding                                          |
+| `columns_ordinal`       | list  | `[]`    | Columns for ordinal encoding                                         |
+| `columns_frequency`     | list  | `[]`    | Columns for frequency encoding                                       |
+
+#### Feature Selection Parameters
+
+| Parameter                   | Type  | Default | Description                                                      |
+|-----------------------------|-------|---------|------------------------------------------------------------------|
+| `percentile`                | float | `20`    | Percentage of features to keep per selection method             |
+| `corr_threshold`            | float | `80`    | Maximum correlation threshold (%) between features              |
+| `max_features`              | int   | `50`    | Maximum number of final features                                |
+| `max_p_value_categorical`   | float | `0.05`  | Maximum p-value for categorical feature selection (Chi2)        |
+
+#### Model Selection Parameters
+
+| Parameter              | Type  | Default | Description                                                           |
+|------------------------|-------|---------|-----------------------------------------------------------------------|
+| `target_numbers`       | list  | `[]`    | List of target indices to predict                                     |
+| `target_clf`           | list  | `[]`    | Classification target indices                                         |
+| `models_idx`           | list  | `[]`    | Model indices or names to use (e.g., `[1, 'xgb', 'lgb']`)           |
+| `max_timesteps`        | int   | `120`   | Maximum timesteps for recurrent models                               |
+| `perform_hyperopt`     | bool  | `True`  | Whether to perform hyperparameter optimization                       |
+| `number_of_trials`     | int   | `20`    | Number of hyperopt trials                                            |
+| `perform_crossval`     | bool  | `False` | Whether to use cross-validation during hyperopt                      |
+| `plot`                 | bool  | `True`  | Whether to generate plots                                            |
+| `preserve_model`       | bool  | `True`  | Whether to save the best model                                       |
+| `target_clf_thresholds`| dict  | `{}`    | Classification thresholds per target                                 |
+
+#### Example Context Configuration
+
+```python
+context = {
+    # Required parameters
+    "experiment_name": f"stock_{datetime.now().strftime('%Y%m%d_%H%M%S')}",
+    "date_column": "DATE",
+    "group_column": "STOCK",
+    
+    # Feature selection
+    "corr_threshold": 80,
+    "max_features": 20,
+    "percentile": 20,
+    "max_p_value_categorical": 0.05,
+    
+    # Feature engineering
+    "columns_drop": ["SECURITY", "ISIN", "ID"],
+    "columns_boolean": [],
+    "columns_date": ["DATE"],
+    "columns_te_groupby": [["SECTOR", "DATE"]],
+    "columns_te_target": ["RET", "VOLUME"],
+    
+    # Preprocessing
+    "time_series": True,
+    "val_size": 0.2,
+    "test_size": 0.2,
+    "pca_temporal": [
+        {"name": "LAST_20_RET", "columns": [f"RET_-{i}" for i in range(1, 21)]},
+    ],
+    "pca_cross_sectional": [
+        {
+            "name": "MARKET_REGIME",
+            "index": "DATE",
+            "columns": "STOCK",
+            "value": "RET",
+        }
+    ],
+    "columns_onehot": ["BUY_SIGNAL"],
+    "columns_binary": ["SECTOR", "LOCATION"],
+    "columns_ordinal": ["STOCK"],
+    
+    # Model selection
+    "target_numbers": [1, 2, 3],
+    "target_clf": [1],
+    "models_idx": ["xgb", "lgb", "catboost"],
+    "max_timesteps": 120,
+    "perform_hyperopt": True,
+    "number_of_trials": 50,
+    "perform_crossval": True,
+    "plot": True,
+    "preserve_model": True,
+    "target_clf_thresholds": {1: {"precision": 0.80}},
+}
+
+# Create experiment
+experiment = app.create_experiment(data=your_dataframe, **context)
+```
+
+#### Important Notes
+
+1. **Context Persistence**: All context parameters are saved in the database when creating an experiment and automatically restored when loading it.
+
+2. **Parameter Precedence**: When loading an existing experiment, the stored context takes precedence over any parameters passed to the constructor.
+
+3. **PCA Time Series**: For time series data with `pca_cross_sectional` where index equals `date_column`, the system automatically uses an expanding window approach to prevent data leakage.
+
+4. **OpenAI Embeddings**: If using `columns_pca` with text columns, ensure `OPENAI_API_KEY` is set as an environment variable.
+
+5. **Model Indices**: The `models_idx` parameter accepts both integer indices and string names (e.g., `'xgb'`, `'lgb'`, `'catboost'`).
+
+
+
+### Modular usage
+
+You can also use each step independently:
+
+```python
+data_eng = experiment.feature_engineering(data)
+train, val, test = experiment.preprocess_feature(data_eng)
+features = experiment.feature_selection(train)
+std_data, reshaped_data = experiment.preprocess_model(train, val, test)
+experiment.model_selection(std_data, reshaped_data)
+```
+
+## ⚠️ Using Alembic in Your Project (Important for Integrators)
+
+If you use Alembic for migrations in your own project and you share the same database with LeCrapaud, you must ensure that Alembic does **not** attempt to drop or modify LeCrapaud tables (those prefixed with `{LECRAPAUD_TABLE_PREFIX}_`).
+
+By default, Alembic's autogenerate feature will propose to drop any table that exists in the database but is not present in your project's models. To prevent this, add the following filter to your `env.py`:
+
+```python
+def include_object(object, name, type_, reflected, compare_to):
+    if type_ == "table" and name.startswith(f"{LECRAPAUD_TABLE_PREFIX}_"):
+        return False  # Ignore LeCrapaud tables
+    return True
+
+context.configure(
+    # ... other options ...
+    include_object=include_object,
+)
+```
+
+This will ensure that Alembic ignores all tables created by LeCrapaud when generating migrations for your own project.
+
+---
+
+## 🤝 Contributing
+
+### Reminders for Github usage
+
+1. Creating Github repository
+
+```sh
+$ brew install gh
+$ gh auth login
+$ gh repo create
+```
+
+2. Initializing git and first commit to distant repository
+
+```sh
+$ git init
+$ git add .
+$ git commit -m 'first commit'
+$ git remote add origin <YOUR_REPO_URL>
+$ git push -u origin master
+```
+
+3. Use conventional commits  
+https://www.conventionalcommits.org/en/v1.0.0/#summary
+
+4. Create environment
+
+```sh
+$ pip install virtualenv
+$ python -m venv .venv
+$ source .venv/bin/activate
+```
+
+5. Install dependencies
+
+```sh
+$ make install
+```
+
+6. Deactivate virtualenv (if needed)
+
+```sh
+$ deactivate
+```
+
+---
+
+Pierre Gallet © 2025