contentconvertor 0.2.3
Converti des tweets en images pour Instagram
License: MIT
Requires Python: >=3.9
Keywords: instagram,twitter,content,convertor

# Content-Convertor

Content-Convertor est un package python permettant de convertir des tweets en fichiers png prêts à être postés sur Instagram.
![Exemple](media/banniere.png)
## Installation
Pour l'installer, il suffit de lancer la commande : `pip install contentconvertor`.

## Utilisation

Importez le package avec le code suivant : 
```python
from contentconvertor import tweet2gram as t2g  
```
Ce package comprends différentes fonctions.

### 1. Se connecter à l'API de Twitter
`connexion_to_api` : permet de se connecter à l'API de Twitter. Il faut pour cela rentrer les clés d'API et les tokens d'accès. Pour les obtenir, il faut créer une application sur le site de Twitter.  
**Liste des paramètres dans l'ordre**
- `bearer_token` : clé d'API (Bearer Token)

**Retourne la connexion à l'API de Twitter**
- Code d'exemple : 
    ```python
    api = t2g.connexion_to_api(bearer_token="")
    ```
### 2. Récupérer l'ID de l'utilisateur  
`get_user_id` : permet de récupérer l'id d'un utilisateur. Il faut pour cela rentrer le nom de l'utilisateur.  
**Liste des paramètres dans l'ordre**  
- `api` : connexion à l'API de Twitter (obtenue avec la fonction `connexion_to_api`)  
- `username` : nom de l'utilisateur (sans le @)

**Retourne l'id de l'utilisateur**
- Code d'exemple : 
    ```python
    user_id = t2g.get_user_id(api, "iziatask")
    ```
### 3. Récupérer les tweets
`get_tweets` : permet de récupérer les tweets d'un utilisateur. Il faut pour cela rentrer le nom de l'utilisateur et le nombre de tweets à récupérer.  
**Liste des paramètres dans l'ordre**
- Obligatoire :
    - `api` : connexion à l'API de Twitter (obtenue avec la fonction `connexion_to_api`)
    - `user_id` : ID de l'utilisateur (obtenu avec la fonction `get_user_id`)
- Optionnel :
    - `nb_tweets` : nombre de tweets à récupérer (par défaut : 5)
    - `exclude` : exclure les tweets de type "replies" ou "retweets" (par défaut : None) 

**Retourne une liste de tweets**  
- Code d'exemple : 
    - Minimum requis
    ```python
    list_tweets = t2g.get_tweets(api, user_id)
    ```
    - Avec tous les paramètres
    ```python
    list_tweets = t2g.get_tweets(api, user_id, nb_tweets=5, exclude=["replies", "retweets"])
    ```
### 4. Télécharger les tweets
`download_tweets` : 
- permet de télécharger au format png les tweets d'un utilisateur.  
- permet de télécharger au format png un tweet en particulier.

**Liste des paramètres dans l'ordre**  
- Obligatoire :
    - `user` : utilisateur 
    - `tweet` : (itérer sur la liste obtenue avec la fonction `get_tweets`)
    ou
    - `link` : lien du tweet
- Optionnel :
    - `path` : chemin où télécharger les tweets (par défaut : "")
    - `name` : nom du fichier (par défaut : "tweet")
    - `mode` : mode de capture d'écran (par défaut  : 0)
    - `nigh_mode` : mode nuit (par défaut : 2)  

**Retourne rien, vous aurez vos tweets téléchargés au format png, à l'endroit où vous avez lancé votre script.**
- Code d'exemple :  
- Avec la liste de tweets obtenue avec la fonction `get_tweets`
    - Minimum requis
    ```python
    for tweet in list_tweets.data:
        t2g.download_tweets(user, tweet)
    ```
    - Avec tous les paramètres
    ```python
    for tweet in list_tweets.data:
        t2g.download_tweets(user, tweets, path="images/", name="screenshot", mode=0, nigh_mode=2)
    ```
- Avec le lien du tweet
    - Minimum requis
    ```python
    t2g.download_tweets(user, link="https://twitter.com/iziatask/status/1606364038195093504")
    ```
    - Avec tous les paramètres
    ```python
    t2g.download_tweets(user, link="https://twitter.com/iziatask/status/1606364038195093504", path="images/", name="screenshot", mode=0, nigh_mode=2)
    ```

## Exemple d'utilisation
Pour voir un exemple d'utilisation complet, rendez-vous ici : [GitHub](https://github.com/leoleducq/Content-Convertor/blob/master/example/example.py).