chore: github publication

.github/workflows/documentation.yml

@@ -2,27 +2,24 @@ name: Documentation
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   Documentation:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-
-      - name: Set PY variable
-        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
-
-      - name: Install dependencies
-        run: poetry install
-
-      - name: Set up Git
-        run: |
-          git config user.name ${{ github.actor }}
-          git config user.email ${{ github.actor }}@users.noreply.github.com
-      - name: Build documentation
-        run: |
-          git fetch origin gh-pages
-          poetry run mike delete master
-          poetry run mike deploy --push master
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install '.[dev]'
+    - name: Set up Git
+      run: |
+        git config user.name ${{ github.actor }}
+        git config user.email ${{ github.actor }}@users.noreply.github.com
+    - name: Build documentation
+      run: |
+        git fetch origin gh-pages
+        mike delete main
+        mike deploy --push main

.github/workflows/release.yml

@@ -13,6 +13,20 @@ on:
     types: [published]
 
 jobs:
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v2
+        with:
+          path: dist/*.tar.gz
+
   PyPI:
     name: Upload to PyPI
 

.github/workflows/tests.yml

@@ -3,7 +3,7 @@ name: Tests and Linting
 on:
   pull_request:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   Linting:

.gitignore

@@ -63,7 +63,6 @@ coverage.xml
 *.xlsx
 *.pkl
 *.jpg
-*.png
 *.html
 *.pickle
 *.joblib

.pre-commit-config.yaml

@@ -39,6 +39,3 @@ repos:
       - id: interrogate
         args: ["--config=pyproject.toml"]
         pass_filenames: false
-        ignore-nested-functions: true
-        ignore-private: true
-        ignore-semiprivate: true

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Assistance Publique - Hôpitaux de Paris
+Copyright 2023 Assistance Publique - Hôpitaux de Paris
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

README.md

@@ -1,3 +1,9 @@
+![Tests](https://img.shields.io/github/actions/workflow/status/aphp/confit/tests.yml?branch=main&label=tests&style=flat-square)
+[![Documentation](https://img.shields.io/github/actions/workflow/status/aphp/confit/documentation.yml?branch=main&label=docs&style=flat-square)](https://aphp.github.io/confit/latest/)
+[![PyPI](https://img.shields.io/pypi/v/confit?color=blue&style=flat-square)](https://pypi.org/project/confit/)
+[![Codecov](https://img.shields.io/codecov/c/github/aphp/confit?logo=codecov&style=flat-square)](https://codecov.io/gh/aphp/confit)
+
+
 # Confit
 
 Confit is a complete and easy-to-use configuration framework aimed at improving the reproducibility
@@ -10,8 +16,8 @@ Install the library with pip:
 
 <div class="termy">
 
-```console
-$ pip install confit
+```bash
+pip install confit
 ```
 
 </div>
@@ -84,8 +90,8 @@ and run the following command from the terminal
 
 <div class="termy">
 
-```console
-$ python script.py --config config.cfg --seed 42
+```bash
+python script.py --config config.cfg --seed 42
 ```
 
 </div>
@@ -114,7 +120,7 @@ func(
 ```
 
 
-Visit the [documentation](https://datasciencetools-pages.eds.aphp.fr/confit) for more information!
+Visit the [documentation](https://aphp.github.io/confit/) for more information!
 
 ## Acknowledgement
 

docs/index.en.md

@@ -52,7 +52,7 @@ Combined with our configuration system, dictionaries passed as arguments to a de
 
 ### CLI
 
-Documentation en cours
+TBD
 
 ## The Config object
 
@@ -131,7 +131,7 @@ class MyClass:
 +         self.hidden_value = 99
 ```
 
-To access those values directly in the configuration file, use the ${<obj:attribute>} syntax (notice the **colon** instead of the **point**)
+To access those values directly in the configuration file, use the `${<obj:attribute>}` syntax (notice the **colon** instead of the **point**)
 
 
 ```ini title="config.cfg"

docs/index.fr.md

@@ -126,7 +126,7 @@ class MyClass:
 +         self.hidden_value = 99
 ```
 
-Pour accéder à ces valeurs directement dans le fichier de configuration, utilisez la syntaxe ${<obj:attribut>} (remarquez les **deux points** au lieu du **point**)
+Pour accéder à ces valeurs directement dans le fichier de configuration, utilisez la syntaxe `${<obj:attribut>}` (remarquez les **deux points** au lieu du **point**)
 
 
 ```ini title="config.cfg"

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Confit
 
-repo_url: https://gitlab.eds.aphp.fr/datasciencetools/confit
+repo_url: https://github.com/aphp/confit
 # repo_name: algorithms/pseudonymisation
 
 theme:
@@ -51,10 +51,10 @@ watch:
 extra:
   alternate:
     - name: English
-      link: /en/
+      link: /confit/en/
       lang: en
     - name: Français
-      link: /fr/
+      link: /confit/fr/
       lang: fr
   version:
     provider: mike

pyproject.toml

@@ -27,6 +27,7 @@ dev = [
     "mkdocs-bibtex>=2.0.3,<3.0",
     "mkdocs-glightbox>=0.1.6,<1.0.0",
     "mkdocs-material>=8.2,<9.0",
+    "mkdocs-material-extensions>=1.1.1,<2.0.0",
     "mkdocs-static-i18n>=0.53,<1.0.0",
     "mkdocstrings>=0.18.1,<1.0.0",
     "mkdocstrings-python>=0.6,<1.0.0",