Skip to content
This repository was archived by the owner on Oct 24, 2024. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
gregpriday committed Mar 15, 2024
1 parent a5eb66e commit fe4a330
Show file tree
Hide file tree
Showing 28 changed files with 308 additions and 657 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: :vendor_name
github: Greg Priday
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
url: https://github.com/Greg Priday/laravel-claude-chat/discussions/new?category=q-a
about: Ask the community for help
- name: Request a feature
url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
url: https://github.com/Greg Priday/laravel-claude-chat/discussions/new?category=ideas
about: Share ideas for new features
- name: Report a security issue
url: https://github.com/:vendor_name/:package_name/security/policy
url: https://github.com/Greg Priday/laravel-claude-chat/security/policy
about: Learn how to notify us for sensitive bugs
19 changes: 0 additions & 19 deletions .github/dependabot.yml

This file was deleted.

33 changes: 0 additions & 33 deletions .github/workflows/dependabot-auto-merge.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/update-changelog.yml

This file was deleted.

14 changes: 13 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Changelog

All notable changes to `:package_name` will be documented in this file.
All notable changes to Laravel Claude Chat will be documented in this file.

## 0.1.0 - 2024-03-15

### Added
- Initial release of the Laravel Claude Chat package 🎉
- `ClaudeChat` class for sending requests to the Claude API
- `create` method for sending custom requests to the Claude API
- `createJson` method for retrieving JSON responses from the Claude API
- `ClaudeChatServiceProvider` for registering the package with Laravel
- `ClaudeModels` class for storing constant values of Claude models
- `ClaudeChat` facade for convenient access to the `ClaudeChat` class
- Configuration file for setting the Claude API key, endpoint, request timeout, and retry parameters
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) :vendor_name <author@domain.com>
Copyright (c) Greg Priday <greg@siteorigin.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
109 changes: 67 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,99 @@
# :package_description
# Laravel Claude Chat

[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
<!--delete-->
---
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
Laravel Claude Chat is a package that provides a simple way to integrate Anthropic's Claude AI into your Laravel application. It allows you to easily send requests to the Claude API and receive responses.

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
---
<!--/delete-->
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
## Features

## Support us

[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
- Easy integration with Laravel
- Supports custom arguments for Claude API requests
- Automatic retry mechanism for failed requests
- Facade for convenient access to the `ClaudeChat` class

## Installation

You can install the package via composer:

```bash
composer require :vendor_slug/:package_slug
composer require gregpriday/laravel-claude-chat
```

You can publish and run the migrations with:
## Configuration

```bash
php artisan vendor:publish --tag=":package_slug-migrations"
php artisan migrate
```

You can publish the config file with:
Publish the configuration file:

```bash
php artisan vendor:publish --tag=":package_slug-config"
php artisan vendor:publish --tag="laravel-claude-chat-config"
```

This is the contents of the published config file:
The published configuration file is located at `config/claude.php`. You need to set your Claude API key and endpoint in this file:

```php
return [
'api_key' => env('CLAUDE_API_KEY'),
'endpoint' => env('CLAUDE_API_URL'),
'request_timeout' => 30,
'retry' => [
'retries' => 5,
'retry_on_status' => [429, 500, 502, 503, 504],
'retry_on_timeout' => true,
'delay' => 1000,
'multiplier' => 2,
'max_delay' => 10000,
],
];
```

Optionally, you can publish the views using
Make sure to add your Claude API key and endpoint to your `.env` file:

```bash
php artisan vendor:publish --tag=":package_slug-views"
```
CLAUDE_API_KEY=your-claude-api-key
CLAUDE_API_URL=https://api.anthropic.com/v1/complete
```

## Usage

You can use the `ClaudeChat` class to send requests to the Claude API:

```php
$variable = new VendorName\Skeleton();
echo $variable->echoPhrase('Hello, VendorName!');
use GregPriday\ClaudeChat\ClaudeChat;

$claudeChat = new ClaudeChat(config('claude.api_key'), config('claude.endpoint'));

$response = $claudeChat->create([
'prompt' => 'Hello, Claude!',
'model' => 'claude-v1',
]);

echo $response->completion;
```

You can also use the `ClaudeChat` facade for a more convenient way to access the class:

```php
use GregPriday\ClaudeChat\Facades\ClaudeChat;

$response = ClaudeChat::create([
'prompt' => 'Hello, Claude!',
'model' => 'claude-v1',
]);

echo $response->completion;
```

### Retrieving JSON Responses

If you want to retrieve the response from Claude as a JSON object, you can use the `createJson` method:

```php
$response = ClaudeChat::createJson([
'prompt' => 'Generate a JSON object with a "message" field.',
]);

$jsonObject = $response->content[0]->object;
```

The `createJson` method automatically extracts the JSON object from the response and returns it as a PHP object.

## Testing

```bash
Expand All @@ -79,13 +108,9 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [:author_name](https://github.com/:author_username)
- [Greg Priday](https://github.com/gregpriday)
- [All Contributors](../../contributors)

## License
Expand Down
53 changes: 26 additions & 27 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,53 +1,52 @@
{
"name": ":vendor_slug/:package_slug",
"description": ":package_description",
"name": "gregpriday/laravel-claude-chat",
"description": "This is my package laravel-claude-chat",
"keywords": [
":vendor_name",
"Greg Priday",
"laravel",
":package_slug"
"laravel-claude-chat"
],
"homepage": "https://github.com/:vendor_slug/:package_slug",
"homepage": "https://github.com/gregpriday/laravel-claude-chat",
"license": "MIT",
"authors": [
{
"name": ":author_name",
"email": "author@domain.com",
"name": "Greg Priday",
"email": "greg@siteorigin.com",
"role": "Developer"
}
],
"require": {
"php": "^8.2",
"spatie/laravel-package-tools": "^1.16",
"illuminate/contracts": "^11.0"
"php": "^8.1",
"caseyamcl/guzzle_retry_middleware": "^2.9",
"guzzlehttp/guzzle": "^7.8",
"illuminate/contracts": "^10.0",
"spatie/laravel-package-tools": "^1.14.0"
},
"require-dev": {
"laravel/pint": "^1.14",
"nunomaduro/collision": "^8.1",
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.22",
"pestphp/pest": "^2.34",
"pestphp/pest-plugin-arch": "^2.7",
"pestphp/pest-plugin-laravel": "^2.3",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan-deprecation-rules": "^1.1",
"phpstan/phpstan-phpunit": "^1.3",
"spatie/laravel-ray": "^1.35"
"laravel/pint": "^1.0",
"nunomaduro/collision": "^7.8",
"larastan/larastan": "^2.0.1",
"orchestra/testbench": "^8.8",
"phpstan/extension-installer": "^1.1",
"phpstan/phpstan-deprecation-rules": "^1.0",
"phpstan/phpstan-phpunit": "^1.0",
"spatie/laravel-ray": "^1.26"
},
"autoload": {
"psr-4": {
"VendorName\\Skeleton\\": "src/",
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
"GregPriday\\ClaudeChat\\": "src/",
"GregPriday\\ClaudeChat\\Database\\Factories\\": "database/factories/"
}
},
"autoload-dev": {
"psr-4": {
"VendorName\\Skeleton\\Tests\\": "tests/",
"GregPriday\\ClaudeChat\\Tests\\": "tests/",
"Workbench\\App\\": "workbench/app/"
}
},
"scripts": {
"post-autoload-dump": "@composer run prepare",
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
"clear": "@php vendor/bin/testbench package:purge-laravel-claude-chat --ansi",
"prepare": "@php vendor/bin/testbench package:discover --ansi",
"build": [
"@composer run prepare",
Expand All @@ -73,10 +72,10 @@
"extra": {
"laravel": {
"providers": [
"VendorName\\Skeleton\\SkeletonServiceProvider"
"GregPriday\\ClaudeChat\\ClaudeChatServiceProvider"
],
"aliases": {
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
"ClaudeChat": "GregPriday\\ClaudeChat\\Facades\\ClaudeChat"
}
}
},
Expand Down
16 changes: 16 additions & 0 deletions config/claude.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

// config for GregPriday/ClaudeChat
return [
'api_key' => env('CLAUDE_API_KEY'),
'endpoint' => env('CLAUDE_ENDPOINT', 'https://api.anthropic.com/v1/messages'),
'request_timeout' => env('CLAUDE_REQUEST_TIMEOUT', 30),
'retry' => [
'retries' => 5,
'retry_on_status' => [429, 500, 502, 503, 504],
'retry_on_timeout' => true,
'delay' => 1000,
'multiplier' => 2,
'max_delay' => 10000,
],
];
6 changes: 0 additions & 6 deletions config/skeleton.php

This file was deleted.

Loading

0 comments on commit fe4a330

Please sign in to comment.