Première version

.gitignore

@@ -0,0 +1 @@
+/.idea

Compagnon.md

@@ -0,0 +1,6 @@
+Ce fichier compagnon t'aidera à garder une trace des différents informations requises dans GitLab pour compléter
+l'automatisation des sauvegardes
+
+- CI_PUSH_TOKEN : 
+- CONVERTKIT_API_KEY : 
+- CONVERTKIT_API_SECRET : 

README.md

@@ -1,92 +1,209 @@
 # Formation ConvertKit Backup
 
+Dans cette formation, tu pourras mettre en place une sauvegarde de ConvertKit sur la plateforme GitLab qui inclus notamment les contacts, les campagnes et les tags.
+
+Comme leur API est en cours de développement, on ne peut pas encore tout extraire ce qui est disponible dans l'interface via l'API, donc le contenu présenté ici sera appelé à évoluer.
+
+La structure générale des abonnements dans ConvertKit est hiérarchique, ce qui nous demandera d'utiliser un système de pagination à deux niveaux:
+
+![](images/pagination-formulaire-abonnes.drawio.png)
+
+Cette partie demande quelques minutes à s'exécuter sur les plus gros comptes.
+
+Cette formation a été testée sur la version de GitLab 14.10.0 et la version de l'API de ConvertKit au 4 juillet 2022.
+
+Ceci va te créer une archive dans le système GitLab qui permettra de reculer dans le temps à partir de la première fois où on va exécuter notre sauvegarde.
+
+## Les prérequis
+
+Je te présente ici une liste des outils nécessaires pour faire cette formation
+
+- [ ] Être sur un ordinateur. Tous les systèmes sont supportés: Windows, macOS ou Linux. Ce tutoriel n'est pas conçu sur mobile.
+- [ ] Un navigateur web récent. Les captures d'écran seront basées sur Google Chrome (Brave ou Edge sont équivalents), ce pourrait être différent pour Opera, Safari ou Firefox.
+- [ ] Un éditeur de texte (et non un traitement de texte). Je te conseille [Notepad++](https://notepad-plus-plus.org/downloads/) sur Windows. Sur macOS, tu peux utiliser TextEdit. Ce sera utile pour copier-coller des informations et utiliser le fichier d'accompagnement `Compagnon.txt`.
+- [ ] Une carte de crédit. Pour activer la fonctionnalité CI/CD, tu devras fournir les informations, mais elle ne sera pas chargée. CI/CD signifie Continuous integration and delivery ou Intégration et livraison continue en français. C'est une méthode d'automatisation de tâches utilisée couramment en génie logiciel. Comme elle consomme les processeurs de GitLab, son utilisation est limitée dans le forfait gratuit.
+
+## Notes importantes
+
+- Cette formation est offerte telle quelle, sans garantie de résultats (mais, pour te rassurer, je l'ai testé depuis quelques semaines !
+- Si le site web ConvertKit change de fonctionnement, cette procédure ne fonctionnera plus et devra être adaptée.
+- J'ai repris certaines captures de ma [formation de sauvegardes pour Notion](https://jevalideca.ck.page/82b2ff46e3). Tu n'auras qu'à remplacer Notion par ConvertKit
+
+## Variables d’environnement pour l’API de ConvertKit
+
+Nous allons avoir besoin de deux variables d’environnement pour que GitLab puisse se connecter à ConvertKit automatiquement. Ce sont les jetons d’application. Ils sont fournis par ConvertKit dans la section Settings / Advanced / API.
+
+![](images/convertkit_api_tokens-1024x661.png)
+
+Nous nommerons ces deux variables comme suit dans GitLab:
+
+- `CONVERTKIT_API_KEY`
+- `CONVERTKIT_API_SECRET`
+
+## Configurer les variables de CI/CD dans GitLab
+
+## Ouvrir un compte chez GitLab.com
+
+Pour ouvrir un compte, visite cette adresse: [https://gitlab.com/users/sign_up](https://gitlab.com/users/sign_up). Entre les informations demandées.
+
+Conserve ton mot de passe précieusement dans un gestionnaire de mot de passe, car ce compte aura accès à tout le contenu de ton espace Notion.
+
+![ouvrir un compte GitLab](images/creer_gitlab.png)
+
+Tu vas ensuite recevoir un courriel de validation pour activer ton compte. Ça va t'amener à une fenêtre pour personnaliser ton compte.
+
+![personnaliser ton compte](images/personnaliser_gitlab.png)
+
+Tu vas ensuite être invité à créer un groupe et un projet. Tu peux compléter ça comme suit.
+
+![créer un groupe et un projet](images/gitlab_nouveau_projet.png)
+
+Après quelques fenêtres, tu devrais arriver à la page d'accueil de GitLab.
+
+## Configurer l'environnement GitLab
+
+Nous allons maintenant configurer GitLab pour exécuter les sauvegardes. Comme nous allons automatiser une opération qui va modifier le contenu du projet que nous avons créé, nous avons besoin d'un jeton d'accès.
+
+Pour le créer, nous allons dans le profil personnel, à partir du menu en haut à gauche, puis `Edit Profile`
+
+![profil personnel](images/gitlab_menu_profile.png)
+
+### Obtenir le jeton pour le CI/CD de GitLab
+
+Dans le menu de gauche, clique sur Access Tokens
+
+![Access Tokens](images/access_token_menu.png)
+
+Nomme le jeton `notionbackup`, et coche la permission `write_repository`. Ensuite, clique sur Create personal access token.
+
+![Create personal access token](images/config_access_token.png)
+
+Il sera généré et apparaitra en haut. Tu peux maintenant le copier auprès de la clé `CI_PUSH_TOKEN` dans le fichier Compagnon.md.
+
+Nous avons maintenant toutes les variables requises pour programmer l'automatisation.
+
+### Configurer les variables d'environnement du projet
+
+Nous allons maintenant prendre toutes les informations que nous avons accumulées dans le fichier Compagnon.md et les mettre dans GitLab.
+
+Nous allons retourner à notre projet par le menu principal en haut à gauche
+
+![menu principal projets](images/menu_acces_projets.png)
+
+Dans la section Settings, nous allons aller ensuite dans CI/CD
+
+![CI/CD](images/settings_cicd.png)
+
+Dans la section Variables, clique sur Expand. En utilisant le bouton Add variable, nous allons insérer les 3 valeurs que nous avons inscrites dans le fichier Compagnon.md. Le deux-points `:` sépare les clés (Key) des valeurs (Value).
+
+Le tableau complété devrait ressembler à ceci:
+
+![tableau des variables](images/tableau_variables_cicd.png)
+
+Nous allons maintenant configurer le script qui fait la sauvegarde.
+
+### Configurer les script qui fera la sauvegarde
+
+Revenons aux fichiers du projet par le menu de gauche: `Repository` puis `Files`.
+
+En haut vers le centre, il y a un bouton `+`. Clique dessus, puis choisis `New File`
+
+![New File](images/gitlab_newfile.png)
+
+Nous allons nommer le fichier `.gitlab-ci.yml`. Le point au début est important.
+
+Nous allons y mettre le contenu du fichier `_gitlab-ci.yml` que tu as téléchargé avec ce manuel dans l'éditeur de code de la page. 
+
+La raison pourquoi nous le faisons manuellement est que les fichiers avec un point au début sont parfois cachés sur les systèmes. Sinon, ils sont aussi pour déclencher des actions automatiques, ce que je ne souhaitais pas pour le dépôt de ma formation, alors c'est juste mieux parfois d'y aller manuellement.
+
+![New File .gitlab-ci.yml](images/new_file_gitlab_ci.png)
+
+Je vais aussi te demander de copier le contenu des fichiers
+
+- `envset.sh`, 
+- `merge_gen.sh`,
+- `convertkit-backup.py` 
+
+dans le même répertoire.
+
+Tu peux maintenant faire un commit, qui est l'équivalent d'une sauvegarde dans le monde du CI/CD.
+
+Nous allons maintenant aller voir ce qu'il se passe après le commit. Le principe de l'intégration continue, c'est qu'à chaque commit, on exécute le programme `.gitlab-ci.yml` qui sert, dans le monde logiciel, à compiler et tester chaque nouvelle version avant de la rendre disponible aux clients.
+
+Dans le menu de gauche, il faut aller dans `CI/CD`, puis `Pipelines`.
+
+Tu verras qu'il y a une exécution à Failed et c'est normal.
+
+![exécution à Failed](images/gitlab_cicd_pipeline_fail_validate_account.png)
+
+### Configurer la carte de crédit pour activer les runners.
+
+Depuis 2021, GitLab demande une carte de crédit pour utiliser la fonctionnalité CI/CD avec les 400 minutes gratuites offertes. Ceci est pour limiter l'exploitation des ressources par la création de comptes multiples.
+
+Tu dois donc à cette étape-ci, cliquer sur `Validate your account`.
+
+![Validate your account](images/gitlab_validate_user_acct.png)
+
+Après avoir entré tes informations de crédit et résolu le Captcha, tu verras ce message en haut de la page.
+
+> Your account has been validated
+> You'll now be able to take advantage of free CI/CD minutes on shared runners.
+
+![account validated](images/gitlab_account_validated.png)
+
+### Programmer le séquenceur
+
+Nous allons programmer le séquenceur pour l'exécution périodique de la sauvegarde è chaque semaine.
+
+Dans le menu de gauche, aller dans `CI/CD`, puis `Schedules`.
+
+![Schedules](images/gitlab_cicd_schedules.png)
+
+Clique `New Schedule`, puis remplis le formulaire comme suit.
+
+Le second nombre dans la section `Interval Pattern` / `Custom` est l'heure d'exécution. Le format utilisé est nommé `cron`. Il s'agit d'une syntaxe standard pour la planification de tâches sur Linux.
+
+Ici, dans l'exemple, le script va rouler chaque jeudi à 13h00.
+
+![Interval Pattern](images/gitlab_convertkit_schedule_pipeline.png)
+
+### Exécuter une première fois
+
+Clique le triangle (play) pour lancer le pipeline.
+
+![](images/gitlab_pipeline_schedule_click_play.png)
+
+Lors de l'exécution, le pipeline a un statut à `running`.
+
+![running](images/gitlab_pipeline_running.png)
+
+Lorsque c'est complété, le pipeline a un statut à `passed`.
+
+![passed](images/gitlab_pipeline_success.png)
+
+Retourne maintenant dans le projet
+
+![menu principal projets](images/menu_acces_projets.png)
+
+Tu peux maintenant voir un dossier `json` qui contient la sauvegarde de ton compte ConvertKit.
+
+## Conclusion
+
+J'espère que tu as apprécié cette formation.
+
+Pour toute question, je t'invite à communiquer avec moi via <mailto:apprenant@jevalide.ca>
+
+Merci et à bientôt !
+
+François
+
+L'allié de ton autonomie numérique
+
+## Licence
+
+![](images/cc-by-nc-sa.png)
+
+Ce(tte) \{oe}uvre est mise à disposition selon les termes de la [Licence Creative Commons Attribution - Pas d'Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/).
 
 
-## Getting started
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://git.francoispelletier.org/partage/formation-convertkit-backup.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://git.francoispelletier.org/partage/formation-convertkit-backup/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

_gitlab-ci.yml

@@ -0,0 +1,19 @@
+image: python:3-alpine
+
+stages:
+  - execution
+
+execution:
+  stage: execution
+  script:
+    - apk update && apk add gettext && apk add git
+    - pip install -r requirements.txt
+    - envsubst < envset.sh | sh
+    - python convertkit-backup.py
+    - git remote set-url origin https://${GITLAB_USER_ID}:${CI_PUSH_TOKEN}@git.francoispelletier.org/${CI_PROJECT_PATH}.git
+    - git config --global user.email ${GITLAB_USER_EMAIL}
+    - git config --global user.name ${GITLAB_USER_ID}
+    - sh merge_gen.sh
+  variables:
+    CONVERTKIT_API_KEY: ${CONVERTKIT_API_KEY}
+    CONVERTKIT_API_SECRET: ${CONVERTKIT_API_SECRET}

convertkit-backup.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+import os
+import time
+
+import requests
+
+import json
+
+api_key = os.getenv("CONVERTKIT_API_KEY")
+api_secret = os.getenv("CONVERTKIT_API_SECRET")
+print("API key: "+str(api_key))
+print("API sec: "+str(api_secret))
+base_url = "https://api.convertkit.com"
+
+try:
+    os.mkdir("./json")
+except OSError as error:
+    pass
+
+r = requests.get(url=base_url + "/v3/account", params={"api_secret": api_secret})
+account = r.json()
+print(account)
+
+## Forms
+
+r = requests.get(url=base_url + "/v3/forms", params={"api_secret": api_secret})
+forms = r.json()
+form_ids = [form.get("id") for form in forms.get("forms")]
+
+## Subscribers
+
+subscribers_list = []
+for form_id in form_ids:
+    r = requests.get(url=base_url + "/v3/forms/" + str(form_id) + "/subscriptions", params={"api_secret": api_secret,
+                                                                                            "subscriber_state": "active",
+                                                                                            "page": 1})
+    page1 = r.json()
+    nb_pages = page1.get("total_pages")
+    subscribers_list.append(page1)
+    if nb_pages > 1:
+        for i in range(1, nb_pages):
+            time.sleep(1)
+            page = requests.get(url=base_url + "/v3/forms/" + str(form_id) + "/subscriptions",
+                                params={"api_secret": api_secret,
+                                        "subscriber_state": "active",
+                                        "page": i + 1})
+            subscribers_list.append(page.json())
+
+subscribers = {"subscribers": subscribers_list}
+
+## Tags
+
+r = requests.get(url=base_url + "/v3/tags", params={"api_secret": api_secret})
+tags = r.json()
+tag_ids = [tagdict.get("id") for tagdict in tags.get("tags")]
+
+## tag subs
+
+tag_subscriptions = []
+for tag_id in tag_ids:
+    r = requests.get(url=base_url + "/v3/tags/" + str(tag_id) + "/subscriptions",
+                     params={"api_secret": api_secret, "page": 1, "subscriber_state": "active"})
+    tag_subscription_page1 = r.json()
+    tag_subscriptions.append(tag_subscription_page1)
+    nb_pages = tag_subscription_page1.get("total_pages")
+    if nb_pages > 1:
+        for i in range(1, nb_pages):
+            time.sleep(1)
+            page = requests.get(url=base_url + "/v3/tags/" + str(tag_id) + "/subscriptions",
+                                params={"api_secret": api_secret, "page": i + 1, "subscriber_state": "active"})
+            tag_subscriptions.append(page.json())
+
+tag_subs = {"tag_subscriptions": tag_subscriptions}
+
+## Sequences
+
+r = requests.get(url=base_url + "/v3/sequences", params={"api_secret": api_secret})
+sequences = r.json()
+sequences_ids = [sequencesdict.get("id") for sequencesdict in sequences.get("courses")]
+
+## Sequence subs
+
+sequences_subscriptions = []
+for sequences_id in sequences_ids:
+    r = requests.get(url=base_url + "/v3/sequences/" + str(sequences_id) + "/subscriptions",
+                     params={"api_secret": api_secret, "page": 1, "subscriber_state": "active"})
+    sequences_subscription_page1 = r.json()
+    sequences_subscriptions.append(sequences_subscription_page1)
+    nb_pages = sequences_subscription_page1.get("total_pages")
+    if nb_pages > 1:
+        for i in range(1, nb_pages):
+            time.sleep(1)
+            page = requests.get(url=base_url + "/v3/sequences/" + str(sequences_id) + "/subscriptions",
+                                params={"api_secret": api_secret, "page": i + 1, "subscriber_state": "active"})
+            sequences_subscriptions.append(page.json())
+
+sequences_subs = {"sequences_subscriptions": sequences_subscriptions}
+
+## Broadcasts
+
+r = requests.get(url=base_url + "/v3/broadcasts", params={"api_secret": api_secret})
+broadcasts = r.json()
+broadcasts_ids = [broadcastsdict.get("id") for broadcastsdict in broadcasts.get("broadcasts")]
+for broadcasts_id in broadcasts_ids:
+    time.sleep(1)
+    r = requests.get(url=base_url + "/v3/broadcasts/" + str(broadcasts_id), params={"api_secret": api_secret})
+    broadcast_content = r.json()
+    rstats = requests.get(url=base_url + "/v3/broadcasts/" + str(broadcasts_id) + "/stats",
+                          params={"api_secret": api_secret})
+    broadcast_stats = rstats.json()
+    with open('./json/broadcast_content_' + str(broadcasts_id) + '.json', 'w') as f:
+        json.dump(broadcast_content, f)
+    with open('./json/broadcast_stats_' + str(broadcasts_id) + '.json', 'w') as f:
+        json.dump(broadcast_stats, f)
+
+## Output
+
+with open('./json/account.json', 'w') as f:
+    json.dump(account, f)
+with open('./json/forms.json', 'w') as f:
+    json.dump(forms, f)
+with open('./json/subscribers.json', 'w') as f:
+    json.dump(subscribers, f)
+with open('./json/tags.json', 'w') as f:
+    json.dump(tags, f)
+with open('./json/tag_subs.json', 'w') as f:
+    json.dump(tag_subs, f)
+with open('./json/sequences.json', 'w') as f:
+    json.dump(sequences, f)
+with open('./json/sequences_subs.json', 'w') as f:
+    json.dump(sequences_subs, f)
+with open('./json/broadcasts.json', 'w') as f:
+    json.dump(broadcasts, f)

envset.sh

@@ -0,0 +1,2 @@
+export CONVERTKIT_API_KEY="${CONVERTKIT_API_KEY}"
+export CONVERTKIT_API_SECRET="${CONVERTKIT_API_SECRET}"

merge_gen.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+set -e
+
+mkdir -p json
+
+stats="$(git diff --shortstat | xargs)"
+if [ -z "${stats}" ]; then stats=none; fi
+
+printf "Updated: %s\n\nUpdates: %s" "$(date)" "${stats}" > README.md
+
+git add json README.md && git commit -m "Updates: ${stats}"
+git push origin HEAD:main
+
+exit 0

requirements.txt

@@ -0,0 +1 @@
+requests~=2.25.1