| Name | skyBridge JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | https://github.com/4xe1/skyBridge |
| Summary | A Python interface for interacting with the BlueSky social network's API. |
| upload_time | 2023-10-09 21:21:44 |
| maintainer | |
| docs_url | None |
| author | Axel Merlo |
| requires_python | >=3.6 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# skyBridge Library
`skyBridge` is a Python library providing a streamlined interface to interact with 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 BlueSky.
- Functions to post text and images to BlueSky.
## Installation
```bash
pip install skyBridge
```
## Usage
### Creating a Session
Start by establishing a session with your BlueSky handle and password:
```python
from skyBridge import SkyBridgeSession
session = SkyBridgeSession("your_handle.bsky.social", "your_password")
```
### Posting Content
After initializing a session, you can post text to BlueSky:
```python
from skyBridge 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 skyBridge 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/skyBridge",
"name": "skyBridge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Axel Merlo",
"author_email": "contact@axelm.fr",
"download_url": "https://files.pythonhosted.org/packages/3e/b5/bcda14993e5f42845b9500ba8129b819d17fc79ea388f441a087b1843a07/skyBridge-0.1.3.tar.gz",
"platform": null,
"description": " # skyBridge Library\n\n `skyBridge` is a Python library providing a streamlined interface to interact with 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 BlueSky.\n - Functions to post text and images to BlueSky.\n\n ## Installation\n\n ```bash\n pip install skyBridge\n ```\n\n ## Usage\n\n ### Creating a Session\n\n Start by establishing a session with your BlueSky handle and password:\n\n ```python\n from skyBridge import SkyBridgeSession\n\n session = SkyBridgeSession(\"your_handle.bsky.social\", \"your_password\")\n ```\n\n ### Posting Content\n\n After initializing a session, you can post text to BlueSky:\n\n ```python\n from skyBridge 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 skyBridge 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": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/4xe1/skyBridge"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dee47f53f5f47d7184772a0748746e3812cd182f4c7113ee112414a11099d05f",
"md5": "ae937e27116019c836409a907c9a7628",
"sha256": "b660d1ec3032cd5f351cd4c87a1553de61df8f48dbb1944cf1a698d3569a333e"
},
"downloads": -1,
"filename": "skyBridge-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae937e27116019c836409a907c9a7628",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6440,
"upload_time": "2023-10-09T21:21:43",
"upload_time_iso_8601": "2023-10-09T21:21:43.211247Z",
"url": "https://files.pythonhosted.org/packages/de/e4/7f53f5f47d7184772a0748746e3812cd182f4c7113ee112414a11099d05f/skyBridge-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3eb5bcda14993e5f42845b9500ba8129b819d17fc79ea388f441a087b1843a07",
"md5": "c768bdd7d5d37facb64e4d78aaadd240",
"sha256": "0aade6ec0c8dc4124a3374721cfca62955ea97437ec7bf703edb39f784cac387"
},
"downloads": -1,
"filename": "skyBridge-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c768bdd7d5d37facb64e4d78aaadd240",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5265,
"upload_time": "2023-10-09T21:21:44",
"upload_time_iso_8601": "2023-10-09T21:21:44.675989Z",
"url": "https://files.pythonhosted.org/packages/3e/b5/bcda14993e5f42845b9500ba8129b819d17fc79ea388f441a087b1843a07/skyBridge-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-09 21:21:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4xe1",
"github_project": "skyBridge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "skybridge"
}
