# [twickster](#)
<samp>
Unofficial Python Twitter API.
## Why twickster ?
I used the official Twitter API frequently before Elon barricaded the basic access, now we have to pay a shit load of benjamens to hook up the access. So I decided to make something else that still makes the API accessing to me, hence twickster (twitter+trickster morphword).
So if you dont have enough money to use the official twitter API, then this is for you.
### Installation
You need to have twickster installed on your machine to start using it which can either be done directly from **GitHub** or using **pip**.
#### Installing directly
You first need to clone or download the repo to your local directory and then move into the project directory as shown in the example and then run the command below;
```bash
git clone https://github.com/mokoshalb/twickster
cd twickster
twickster > python setup.py install
....
```
#### Installing from pip
```bash
pip install twickster --upgrade
```
## How to use twickster?
```python
from twickster import API
if __name__ == '__main__':
try:
api = API()
api.log('Starting Twitter API Engine')
api.login() #login
tweetid = api.getTweetID("https://twitter.com/user/status/1702750653842371060") #accept twitter url as string, returns id of tweet
tweet = api.readTweet(tweetid) #read tweet, accept tweet id as string, returns object of tweet
media = [] #initialize media
medium = api.createMedia("temp.mp4", "tweet_video") #create twitter media, accept 2 parameters, file name path and file type tweet_image for picture and tweet_video for videos
media.append(medium) #store media in array
api.createTweet("i love it here!", media=media) #create tweet, accept up to 4 parameters, tweet text, in_reply_to_tweet_id if it is a reply, media array of media ids if it contains a media, attachment_url id of a tweet to quote in tweet
api.deleteTweet(tweetid) #delete tweet, accept tweet id as string
api.likeTweet(tweetid) #like tweet, accept tweet id as string
api.unlikeTweet(tweetid) #unlike tweet, accept tweet id as string
api.createRetweet(tweetid) #retweet tweet, accept tweet id as string
api.deleteRetweet(tweetid) #delete retweet tweet, accept tweet id as string
api.pinTweet(tweetid) #pin tweet to profile, accept tweet id as string
api.unpinTweet(tweetid) #unpin tweet to profile, accept tweet id as string
api.createBookmark(tweetid) #add tweet to bookmark, accept tweet id as string
api.deleteBookmark(tweetid) #remove tweet from bookmark, accept tweet id as string
api.follow("1324833791974744064") #follow a user, accept user id as string
api.unfollow("1324833791974744064") #unfollow a user, accept user id as string
except Exception as error:
print("Error", error)
```
Well! thats all for now from the package, to request new feature make an issue.
## Contributions
**twickster** is an open-source package, so contributions are warmly welcome.
When contributing to code please make an issue for that before making your changes so that we can have a discussion before implementation.
## Issues
If you're facing any issue or difficulty with the usage of the package just raise one so that we can fix it as soon as possible.
**Please, be as much comprehensive as possible!** Use as many screenshots and detailed description sets as possible; this will save us some time that we'd dedicate on asking you for "a more detailed descriptiton", and it'll make your request be solved faster.
## Give it a star
Was this useful to you ? Then give it a star so that more people can manke use of this.
</samp>
Raw data
{
"_id": null,
"home_page": "https://github.com/mokoshalb/twickster/",
"name": "twickster",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "twickster,python-twitter,Twitter,TwitterAPI,python-twitter-wrapper",
"author": "Okoya Usman",
"author_email": "usmanokoya10@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3a/b2/bb07e75131f9267e3b2f64818c4057c501395e19f61b40e340884f5e0c65/twickster-1.0.1.tar.gz",
"platform": null,
"description": "# [twickster](#)\n\n<samp>\n\nUnofficial Python Twitter API.\n\n## Why twickster ?\n\nI used the official Twitter API frequently before Elon barricaded the basic access, now we have to pay a shit load of benjamens to hook up the access. So I decided to make something else that still makes the API accessing to me, hence twickster (twitter+trickster morphword).\nSo if you dont have enough money to use the official twitter API, then this is for you.\n\n### Installation\n\nYou need to have twickster installed on your machine to start using it which can either be done directly from **GitHub** or using **pip**.\n\n#### Installing directly\n\nYou first need to clone or download the repo to your local directory and then move into the project directory as shown in the example and then run the command below;\n\n```bash\ngit clone https://github.com/mokoshalb/twickster\ncd twickster\ntwickster > python setup.py install \n....\n```\n\n#### Installing from pip\n\n```bash\npip install twickster --upgrade\n```\n\n## How to use twickster?\n\n\n```python\nfrom twickster import API\n\nif __name__ == '__main__':\n try:\n api = API()\n api.log('Starting Twitter API Engine')\n api.login() #login\n\n tweetid = api.getTweetID(\"https://twitter.com/user/status/1702750653842371060\") #accept twitter url as string, returns id of tweet\n\n tweet = api.readTweet(tweetid) #read tweet, accept tweet id as string, returns object of tweet\n\n media = [] #initialize media\n medium = api.createMedia(\"temp.mp4\", \"tweet_video\") #create twitter media, accept 2 parameters, file name path and file type tweet_image for picture and tweet_video for videos\n media.append(medium) #store media in array\n\n api.createTweet(\"i love it here!\", media=media) #create tweet, accept up to 4 parameters, tweet text, in_reply_to_tweet_id if it is a reply, media array of media ids if it contains a media, attachment_url id of a tweet to quote in tweet\n api.deleteTweet(tweetid) #delete tweet, accept tweet id as string\n\n api.likeTweet(tweetid) #like tweet, accept tweet id as string\n api.unlikeTweet(tweetid) #unlike tweet, accept tweet id as string\n\n api.createRetweet(tweetid) #retweet tweet, accept tweet id as string\n api.deleteRetweet(tweetid) #delete retweet tweet, accept tweet id as string\n\n api.pinTweet(tweetid) #pin tweet to profile, accept tweet id as string\n api.unpinTweet(tweetid) #unpin tweet to profile, accept tweet id as string\n\n api.createBookmark(tweetid) #add tweet to bookmark, accept tweet id as string\n api.deleteBookmark(tweetid) #remove tweet from bookmark, accept tweet id as string\n\n api.follow(\"1324833791974744064\") #follow a user, accept user id as string\n api.unfollow(\"1324833791974744064\") #unfollow a user, accept user id as string\n\n except Exception as error:\n print(\"Error\", error)\n```\n\n\nWell! thats all for now from the package, to request new feature make an issue.\n\n## Contributions\n\n**twickster** is an open-source package, so contributions are warmly welcome.\n\nWhen contributing to code please make an issue for that before making your changes so that we can have a discussion before implementation.\n\n## Issues\n\nIf you're facing any issue or difficulty with the usage of the package just raise one so that we can fix it as soon as possible.\n\n**Please, be as much comprehensive as possible!** Use as many screenshots and detailed description sets as possible; this will save us some time that we'd dedicate on asking you for \"a more detailed descriptiton\", and it'll make your request be solved faster.\n\n## Give it a star\n\nWas this useful to you ? Then give it a star so that more people can manke use of this.\n</samp>\n",
"bugtrack_url": null,
"license": "",
"summary": "Unofficial Python Twitter API",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/mokoshalb/twickster/"
},
"split_keywords": [
"twickster",
"python-twitter",
"twitter",
"twitterapi",
"python-twitter-wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ab2bb07e75131f9267e3b2f64818c4057c501395e19f61b40e340884f5e0c65",
"md5": "9b89443894a6cb8707d2b343079a44eb",
"sha256": "75caa5c94118098d8e6e177af849363a16ae6ea8b3989584a3772eb934ded275"
},
"downloads": -1,
"filename": "twickster-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9b89443894a6cb8707d2b343079a44eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8790,
"upload_time": "2023-12-21T09:36:36",
"upload_time_iso_8601": "2023-12-21T09:36:36.039145Z",
"url": "https://files.pythonhosted.org/packages/3a/b2/bb07e75131f9267e3b2f64818c4057c501395e19f61b40e340884f5e0c65/twickster-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 09:36:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mokoshalb",
"github_project": "twickster",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "twickster"
}
JSON
