# bsky-bridge: A Python Library for the BlueSky API
`bsky-bridge` is a Python library designed to bridge the interaction between Python applications and the BlueSky Social Network via its API.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Creating a Session](#creating-a-session)
- [Posting Content](#posting-content)
- [Posting Images](#posting-images)
- [Contribution](#contribution)
- [License](#license)
## Features
- Easy authentication with the BlueSky API.
- Functions to post text and images to BlueSky via the API.
## Installation
```bash
pip install bsky-bridge
```
## Usage
### Creating a Session
Start by establishing a session with your BlueSky handle and **App passwords** *(To be created in your account settings)*:
```python
from bsky_bridge import BskySession
session = BskySession("your_handle.bsky.social", "your_APPpassword")
```
### Posting Content
After initializing a session, you can post text to BlueSky:
```python
from bsky_bridge import post_text
response = post_text(session, "Hello BlueSky!")
print(response)
```
### Posting Images
To post images along with text, you can use the `post_image` method:
```python
from bsky_bridge import post_image
postText = "Check out this cool image!"
imagePath = "path_to_your_image.jpeg"
altText = "An awesome image"
response = post_image(session, postText, imagePath, altText)
print(response)
```
**Note**: The library automatically handles resizing and compressing larger images to ensure they do not exceed 1 MB in size, all while maintaining a quality balance. This ensures efficient and quick image uploads.
## Contribution
Contributions are welcome! Please submit issues for any bug or problem you discover, and pull requests for new features or fixes.
## License
[MIT License](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/4xe1/bsky-bridge",
"name": "bsky-bridge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "bluesky,api,python,bridge,social network,bluesky api,social network api,bluesky python",
"author": "Axel Merlo",
"author_email": "contact@axelm.fr",
"download_url": "https://files.pythonhosted.org/packages/5d/a6/80cd39012e70468557aeac30b845cb0b7e41e80688871ac389a72da8da87/bsky-bridge-1.0.2.tar.gz",
"platform": null,
"description": " # bsky-bridge: A Python Library for the BlueSky API\n\n `bsky-bridge` is a Python library designed to bridge the interaction between Python applications and the BlueSky Social Network via its API.\n\n ## Table of Contents\n\n - [Features](#features)\n - [Installation](#installation)\n - [Usage](#usage)\n - [Creating a Session](#creating-a-session)\n - [Posting Content](#posting-content)\n - [Posting Images](#posting-images)\n - [Contribution](#contribution)\n - [License](#license)\n\n ## Features\n\n - Easy authentication with the BlueSky API.\n - Functions to post text and images to BlueSky via the API.\n\n ## Installation\n\n ```bash\n pip install bsky-bridge\n ```\n\n ## Usage\n\n ### Creating a Session\n\n Start by establishing a session with your BlueSky handle and **App passwords** *(To be created in your account settings)*:\n\n ```python\n from bsky_bridge import BskySession\n\n session = BskySession(\"your_handle.bsky.social\", \"your_APPpassword\")\n ```\n\n ### Posting Content\n\n After initializing a session, you can post text to BlueSky:\n\n ```python\n from bsky_bridge import post_text\n\n response = post_text(session, \"Hello BlueSky!\")\n print(response)\n ```\n\n ### Posting Images\n\n To post images along with text, you can use the `post_image` method:\n\n ```python\n from bsky_bridge import post_image\n\n postText = \"Check out this cool image!\"\n imagePath = \"path_to_your_image.jpeg\"\n altText = \"An awesome image\"\n response = post_image(session, postText, imagePath, altText)\n print(response)\n ```\n\n **Note**: The library automatically handles resizing and compressing larger images to ensure they do not exceed 1 MB in size, all while maintaining a quality balance. This ensures efficient and quick image uploads.\n\n ## Contribution\n\n Contributions are welcome! Please submit issues for any bug or problem you discover, and pull requests for new features or fixes.\n\n ## License\n\n [MIT License](LICENSE)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python interface for interacting with the BlueSky social network's API.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/4xe1/bsky-bridge"
},
"split_keywords": [
"bluesky",
"api",
"python",
"bridge",
"social network",
"bluesky api",
"social network api",
"bluesky python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd57a64d4bd23e39ece0f374bbc31e852bb3471b08c2d3af7ea57af287787c57",
"md5": "ea77af446eeed0d44b0dd81508f01cba",
"sha256": "1ffc05d5c3e1953cdd8477adff640eda6cb37b7e32b02e1004b612aa26c6219e"
},
"downloads": -1,
"filename": "bsky_bridge-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea77af446eeed0d44b0dd81508f01cba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6559,
"upload_time": "2024-03-02T21:50:28",
"upload_time_iso_8601": "2024-03-02T21:50:28.572930Z",
"url": "https://files.pythonhosted.org/packages/bd/57/a64d4bd23e39ece0f374bbc31e852bb3471b08c2d3af7ea57af287787c57/bsky_bridge-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5da680cd39012e70468557aeac30b845cb0b7e41e80688871ac389a72da8da87",
"md5": "f7026dd6b0c90528487ea79ab9dd60bb",
"sha256": "38b04556a9a664aee2a3cd9d06549b27b1806ede9e0cc77feaa02ade06458ba6"
},
"downloads": -1,
"filename": "bsky-bridge-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f7026dd6b0c90528487ea79ab9dd60bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5394,
"upload_time": "2024-03-02T21:50:30",
"upload_time_iso_8601": "2024-03-02T21:50:30.032427Z",
"url": "https://files.pythonhosted.org/packages/5d/a6/80cd39012e70468557aeac30b845cb0b7e41e80688871ac389a72da8da87/bsky-bridge-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-02 21:50:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4xe1",
"github_project": "bsky-bridge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bsky-bridge"
}
JSON
