# Content-Convertor
Content-Convertor est un package python permettant de convertir des tweets en fichiers png prêts à être postés sur Instagram.
## 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/leoleducq/Content-Convertor",
"name": "contentconvertor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "instagram,twitter,content,convertor",
"author": "L\u00e9o Leducq",
"author_email": "iziatask@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5c/11/e3ca1049e58d1dd514e91506571f516b89d2cb25ae67966f48e17723b5c7/contentconvertor-0.2.3.tar.gz",
"platform": null,
"description": "# Content-Convertor\r\n\r\nContent-Convertor est un package python permettant de convertir des tweets en fichiers png pr\u00eats \u00e0 \u00eatre post\u00e9s sur Instagram.\r\n\r\n## Installation\r\nPour l'installer, il suffit de lancer la commande : `pip install contentconvertor`.\r\n\r\n## Utilisation\r\n\r\nImportez le package avec le code suivant : \r\n```python\r\nfrom contentconvertor import tweet2gram as t2g \r\n```\r\nCe package comprends diff\u00e9rentes fonctions.\r\n\r\n### 1. Se connecter \u00e0 l'API de Twitter\r\n`connexion_to_api` : permet de se connecter \u00e0 l'API de Twitter. Il faut pour cela rentrer les cl\u00e9s d'API et les tokens d'acc\u00e8s. Pour les obtenir, il faut cr\u00e9er une application sur le site de Twitter. \r\n**Liste des param\u00e8tres dans l'ordre**\r\n- `bearer_token` : cl\u00e9 d'API (Bearer Token)\r\n\r\n**Retourne la connexion \u00e0 l'API de Twitter**\r\n- Code d'exemple : \r\n ```python\r\n api = t2g.connexion_to_api(bearer_token=\"\")\r\n ```\r\n### 2. R\u00e9cup\u00e9rer l'ID de l'utilisateur \r\n`get_user_id` : permet de r\u00e9cup\u00e9rer l'id d'un utilisateur. Il faut pour cela rentrer le nom de l'utilisateur. \r\n**Liste des param\u00e8tres dans l'ordre** \r\n- `api` : connexion \u00e0 l'API de Twitter (obtenue avec la fonction `connexion_to_api`) \r\n- `username` : nom de l'utilisateur (sans le @)\r\n\r\n**Retourne l'id de l'utilisateur**\r\n- Code d'exemple : \r\n ```python\r\n user_id = t2g.get_user_id(api, \"iziatask\")\r\n ```\r\n### 3. R\u00e9cup\u00e9rer les tweets\r\n`get_tweets` : permet de r\u00e9cup\u00e9rer les tweets d'un utilisateur. Il faut pour cela rentrer le nom de l'utilisateur et le nombre de tweets \u00e0 r\u00e9cup\u00e9rer. \r\n**Liste des param\u00e8tres dans l'ordre**\r\n- Obligatoire :\r\n - `api` : connexion \u00e0 l'API de Twitter (obtenue avec la fonction `connexion_to_api`)\r\n - `user_id` : ID de l'utilisateur (obtenu avec la fonction `get_user_id`)\r\n- Optionnel :\r\n - `nb_tweets` : nombre de tweets \u00e0 r\u00e9cup\u00e9rer (par d\u00e9faut : 5)\r\n - `exclude` : exclure les tweets de type \"replies\" ou \"retweets\" (par d\u00e9faut : None) \r\n\r\n**Retourne une liste de tweets** \r\n- Code d'exemple : \r\n - Minimum requis\r\n ```python\r\n list_tweets = t2g.get_tweets(api, user_id)\r\n ```\r\n - Avec tous les param\u00e8tres\r\n ```python\r\n list_tweets = t2g.get_tweets(api, user_id, nb_tweets=5, exclude=[\"replies\", \"retweets\"])\r\n ```\r\n### 4. T\u00e9l\u00e9charger les tweets\r\n`download_tweets` : \r\n- permet de t\u00e9l\u00e9charger au format png les tweets d'un utilisateur. \r\n- permet de t\u00e9l\u00e9charger au format png un tweet en particulier.\r\n\r\n**Liste des param\u00e8tres dans l'ordre** \r\n- Obligatoire :\r\n - `user` : utilisateur \r\n - `tweet` : (it\u00e9rer sur la liste obtenue avec la fonction `get_tweets`)\r\n ou\r\n - `link` : lien du tweet\r\n- Optionnel :\r\n - `path` : chemin o\u00f9 t\u00e9l\u00e9charger les tweets (par d\u00e9faut : \"\")\r\n - `name` : nom du fichier (par d\u00e9faut : \"tweet\")\r\n - `mode` : mode de capture d'\u00e9cran (par d\u00e9faut : 0)\r\n - `nigh_mode` : mode nuit (par d\u00e9faut : 2) \r\n\r\n**Retourne rien, vous aurez vos tweets t\u00e9l\u00e9charg\u00e9s au format png, \u00e0 l'endroit o\u00f9 vous avez lanc\u00e9 votre script.**\r\n- Code d'exemple : \r\n- Avec la liste de tweets obtenue avec la fonction `get_tweets`\r\n - Minimum requis\r\n ```python\r\n for tweet in list_tweets.data:\r\n t2g.download_tweets(user, tweet)\r\n ```\r\n - Avec tous les param\u00e8tres\r\n ```python\r\n for tweet in list_tweets.data:\r\n t2g.download_tweets(user, tweets, path=\"images/\", name=\"screenshot\", mode=0, nigh_mode=2)\r\n ```\r\n- Avec le lien du tweet\r\n - Minimum requis\r\n ```python\r\n t2g.download_tweets(user, link=\"https://twitter.com/iziatask/status/1606364038195093504\")\r\n ```\r\n - Avec tous les param\u00e8tres\r\n ```python\r\n t2g.download_tweets(user, link=\"https://twitter.com/iziatask/status/1606364038195093504\", path=\"images/\", name=\"screenshot\", mode=0, nigh_mode=2)\r\n ```\r\n\r\n## Exemple d'utilisation\r\nPour voir un exemple d'utilisation complet, rendez-vous ici : [GitHub](https://github.com/leoleducq/Content-Convertor/blob/master/example/example.py).\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Converti des tweets en images pour Instagram",
"version": "0.2.3",
"split_keywords": [
"instagram",
"twitter",
"content",
"convertor"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "eb8ab61b5263cab576b0a20896414e29",
"sha256": "d43d6559b6cdcedb790ba137af5bc8673c40fe2d58438448e9d80041b6ed6e11"
},
"downloads": -1,
"filename": "contentconvertor-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb8ab61b5263cab576b0a20896414e29",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5249,
"upload_time": "2022-12-28T12:45:03",
"upload_time_iso_8601": "2022-12-28T12:45:03.693022Z",
"url": "https://files.pythonhosted.org/packages/1a/06/1540fde38d40ebcbc3650ac807f088b14a6209d51823bd00f23daa7795c2/contentconvertor-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "2bdfa7f4db571a50880d04983c1011e7",
"sha256": "07625f0012a64da65a189f06786d5cdb593212972f2fa39ab2c2951ff0d2ee7c"
},
"downloads": -1,
"filename": "contentconvertor-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "2bdfa7f4db571a50880d04983c1011e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4885,
"upload_time": "2022-12-28T12:45:04",
"upload_time_iso_8601": "2022-12-28T12:45:04.974983Z",
"url": "https://files.pythonhosted.org/packages/5c/11/e3ca1049e58d1dd514e91506571f516b89d2cb25ae67966f48e17723b5c7/contentconvertor-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-28 12:45:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "leoleducq",
"github_project": "Content-Convertor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "contentconvertor"
}
JSON
