https://github.com/ghostwriter/atprotocol
[WIP]Bluesky API Client for AT Protocol
https://github.com/ghostwriter/atprotocol
atp atproto atprotocol bluesky bluesky-api bluesky-app bluesky-bot bluesky-client bluesky-feed bluesky-generator bluesky-social bluesky-webclient ghostwriter lexicon
Last synced: 2 months ago
JSON representation
[WIP]Bluesky API Client for AT Protocol
- Host: GitHub
- URL: https://github.com/ghostwriter/atprotocol
- Owner: ghostwriter
- License: bsd-3-clause
- Created: 2023-11-02T21:36:21.000Z (over 1 year ago)
- Default Branch: 0.1.x
- Last Pushed: 2024-10-21T11:41:25.000Z (9 months ago)
- Last Synced: 2024-10-21T16:55:02.143Z (9 months ago)
- Topics: atp, atproto, atprotocol, bluesky, bluesky-api, bluesky-app, bluesky-bot, bluesky-client, bluesky-feed, bluesky-generator, bluesky-social, bluesky-webclient, ghostwriter, lexicon
- Language: PHP
- Homepage: https://github.com/ghostwriter/atprotocol
- Size: 1.25 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Atprotocol
[](https://github.com/sponsors/ghostwriter)
[](https://github.com/ghostwriter/atprotocol/actions/workflows/automation.yml)
[](https://www.php.net/supported-versions)
[](https://packagist.org/packages/ghostwriter/atprotocol)
> [!WARNING]
>
> This project is not finished yet, work in progress.
## Installation
You can install the package via composer:
``` bash
composer require ghostwriter/atprotocol
```
## Usage
### Auth
> **Info**
>
> Use app passwords to securely login to Bluesky without giving full access to your account or password.
> https://bsky.app/settings/app-passwords
```php
$bsky = new Bluesky(personalDataServer: 'https://bsky.social');
// create a new account on the server
$sessionData = $bsky->createAccount(
email: '[email protected]',
handle: 'codepoet.bsky.social',
password: '************'
inviteCode: 'black-lives-matter',
);
// if an existing session (accessed with 'bsky.session') was securely stored previously, then reuse that
$bsky->resumeSession(session: $sessionData);
// if no old session was available, create a new one by logging in with password (App Password)
$sessionData = $bsky->login(
identifier: 'codepoet.bsky.social',
password: '************'
);
$bsky->post(text: 'My first post using ghostwriter/atprotocol for PHP.');
// Feeds and content
$bsky->getTimeline($params,$opts)
$bsky->getAuthorFeed($params,$opts)
$bsky->getPostThread($params,$opts)
$bsky->getPost($params)
$bsky->getPosts($params,$opts)
$bsky->getLikes($params,$opts)
$bsky->getRepostedBy($params,$opts)
$bsky->post($record)
$bsky->deletePost($postUri)
$bsky->like($uri, cid)
$bsky->deleteLike($likeUri)
$bsky->repost($uri, cid)
$bsky->deleteRepost($repostUri)
$bsky->uploadBlob($data,$opts)
// Social graph
$bsky->getFollows($params,$opts)
$bsky->getFollowers($params,$opts)
$bsky->follow($did)
$bsky->deleteFollow($followUri)
// Actors
$bsky->getProfile($params,$opts)
$bsky->upsertProfile($updateFn)
$bsky->getProfiles($params,$opts)
$bsky->getSuggestions($params,$opts)
$bsky->searchActors($params,$opts)
$bsky->mute($did)
$bsky->unmute($did)
$bsky->muteModList($listUri)
$bsky->unmuteModList($listUri)
$bsky->blockModList($listUri)
$bsky->unblockModList($listUri)
// Notifications
$bsky->listNotifications($params,$opts)
$bsky->countUnreadNotifications($params,$opts)
$bsky->updateSeenNotifications()
// Identity
$bsky->resolveHandle($params,$opts)
$bsky->updateHandle($params,$opts)
// Session management
$bsky->createAccount($params)
$bsky->login($params)
$bsky->resumeSession($session)
// Excepions
// { "name": "InvalidHandle" },
// { "name": "InvalidPassword" },
// { "name": "InvalidInviteCode" },
// { "name": "HandleNotAvailable" },
// { "name": "UnsupportedDomain" },
// { "name": "UnresolvableDid" },
// { "name": "IncompatibleDidDoc" }
// TODO: extract the headers from the lexicon objects
```
### Changelog
Please see [CHANGELOG.md](./CHANGELOG.md) for more information on what has changed recently.
### Security
If you discover any security-related issues, please use [`Security Advisories`](https://github.com/ghostwriter/atprotocol/security/advisories/new) instead of using the issue tracker.
### Credits
- [Nathanael Esayeas](https://github.com/ghostwriter)
- [All Contributors](https://github.com/ghostwriter/atprotocol/contributors)
### License
The BSD-4-Clause. Please see [License File](./LICENSE) for more information.