Initial commit

.github/workflows/d4g-utils.yml

@@ -0,0 +1,68 @@
+name: Copy File to Organization Repos
+
+on:
+  push:
+    paths:
+      - 'd4g-utils/**' # Trigger the workflow only when changes are made in the d4g-utils directory
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  copy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout template repo
+        uses: actions/checkout@v2
+
+      - name: Set up Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "D4G Tech"
+
+      - name: Get organization repositories
+        id: org_repos
+        run: |
+          ORG_NAME="dataforgoodfr"
+          TEMPLATE_REPO="$ORG_NAME/python_template"
+          TOKEN=$1
+
+          # Fetch repositories from the organization
+          repos=`gh repo list $ORG_NAME --limit 500 | awk ' {print $1}'`
+          
+          echo "::set-output name=repos::$repos"
+        env:
+          GH_TOKEN: ${{ secrets.D4GTECH_TOKEN }}
+
+      - name: Copy files to organization repos
+        run: |
+          echo "Searching for repositories generated from template: $template_repo"
+          for repo in ${{ steps.org_repos.outputs.repos }}; do
+            repo_info=`gh api repos/$repo`
+            echo "$repo_info" | jq -r ".template_repository.full_name" | grep "$template_repo" 2>&1 > /dev/null
+            if [ "$?" -eq "0" ]
+            then
+              echo "repo_using_template: $repo"
+            fi
+          done
+        env:
+          GH_TOKEN: ${{ secrets.D4GTECH_TOKEN }}
+
+
+      #     for repo in ${{ steps.org_repos.outputs.repos }}; do
+      #       # Clone the repository
+      #       git clone "https://github.com/$repo" target_repo
+
+      #       # Copy all files from d4g-utils to target repository d4g-utlis
+      #       rsync -av --exclude='.git' d4g-utils/ target_repo/d4g-utils
+
+      #       # Commit and push changes
+      #       cd target_repo
+      #       git add .
+      #       git commit -m "Copy files from d4g-utils directory"
+      #       git push origin main
+
+      #       cd ..
+      #     done

.github/workflows/pre-commit.yaml

@@ -0,0 +1,25 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+
+    - name: Install poetry
+      run: |
+        python -m pip install poetry
+        poetry export --with dev --format=requirements.txt --output=requirements.txt
+    - name: set PY
+      run: echo "PY=$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')" >> $GITHUB_ENV
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pre-commit
+        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+    - uses: pre-commit/[email protected]

.gitignore

@@ -0,0 +1,163 @@
+# From https://github.com/github/gitignore/blob/main/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+bin/
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+lib64
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.env.test
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# VS Code
+.vscode
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# Precommit hooks: ruff cache
+.ruff_cache

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.2.1"
+    hooks:
+      - id: ruff
+        args: [--fix]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+  #- repo: https://github.com/pycqa/bandit
+  #  rev: 1.7.4
+  #  hooks:
+  #  - id: bandit
+  #    exclude: tests/
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
+    rev: v1.3.1
+    hooks:
+      - id: python-safety-dependencies-check

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015-2024 Data4Good
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,68 @@
+# Template DataForGood
+
+This file will become your README and also the index of your
+documentation.
+
+# Contributing
+
+## Installer Poetry
+
+Plusieurs [méthodes d'installation](https://python-poetry.org/docs/#installation) sont décrites dans la documentation de poetry dont:
+
+- avec pipx
+- avec l'installateur officiel
+
+Chaque méthode a ses avantages et inconvénients. Par exemple, la méthode pipx nécessite d'installer pipx au préable, l'installateur officiel utilise curl pour télécharger un script qui doit ensuite être exécuté et comporte des instructions spécifiques pour la completion des commandes poetry selon le shell utilisé (bash, zsh, etc...).
+
+L'avantage de pipx est que l'installation de pipx est documentée pour linux, windows et macos. D'autre part, les outils installées avec pipx bénéficient d'un environment d'exécution isolé, ce qui est permet de fiabiliser leur fonctionnement. Finalement, l'installation de poetry, voire d'autres outils est relativement simple avec pipx.
+
+Cependant, libre à toi d'utiliser la méthode qui te convient le mieux ! Quelque soit la méthode choisie, il est important de ne pas installer poetry dans l'environnement virtuel qui sera créé un peu plus tard dans ce README pour les dépendances de la base de code de ce repo git.
+
+### Installation de Poetry avec pipx
+
+Suivre les instructions pour [installer pipx](https://pipx.pypa.io/stable/#install-pipx) selon ta plateforme (linux, windows, etc...)
+
+Par exemple pour Ubuntu 23.04+:
+
+    sudo apt update
+    sudo apt install pipx
+    pipx ensurepath
+
+[Installer Poetry avec pipx](https://python-poetry.org/docs/#installing-with-pipx):
+
+    pipx install poetry
+
+### Installation de Poetry avec l'installateur officiel
+
+L'installation avec l'installateur officiel nécessitant quelques étapes supplémentaires,
+se référer à la [documentation officielle](https://python-poetry.org/docs/#installing-with-the-official-installer).
+
+## Utiliser un venv python
+
+    python3 -m venv .venv
+
+    source .venv/bin/activate
+
+## Utiliser Poetry
+
+Installer les dépendances:
+
+    poetry install
+
+Ajouter une dépendance:
+
+    poetry add pandas
+
+Mettre à jour les dépendances:
+
+    poetry update
+
+## Lancer les precommit-hook localement
+
+[Installer les precommit](https://pre-commit.com/)
+
+    pre-commit run --all-files
+
+## Utiliser Tox pour tester votre code
+
+    tox -vv