|
1 | | -# LaunchDarkly Server-side AI SDK for Python - Monorepo |
| 1 | +# LaunchDarkly Server-side AI library for Python |
2 | 2 |
|
3 | | -This repository contains the LaunchDarkly AI SDK for Python and its provider packages. |
| 3 | +> **Note:** This repository is a monorepo containing multiple packages. See the [Packages](#packages) section below. |
| 4 | +
|
| 5 | +## LaunchDarkly overview |
| 6 | + |
| 7 | +[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today! |
| 8 | + |
| 9 | +[](https://twitter.com/intent/follow?screen_name=launchdarkly) |
| 10 | + |
| 11 | +## Supported Python versions |
| 12 | + |
| 13 | +This version of the library has a minimum Python version of 3.9. |
4 | 14 |
|
5 | 15 | ## Packages |
6 | 16 |
|
7 | | -### Core SDK |
8 | | -**Package:** [`launchdarkly-server-sdk-ai`](./packages/core/) |
9 | | -**PyPI:** https://pypi.org/project/launchdarkly-server-sdk-ai/ |
10 | | - |
11 | | -The core LaunchDarkly AI SDK providing: |
12 | | -- AI configuration management |
13 | | -- Tracking and metrics |
14 | | -- Provider abstraction layer |
15 | | -- Chat management |
16 | | - |
17 | | -```bash |
18 | | -pip install launchdarkly-server-sdk-ai |
19 | | -``` |
20 | | - |
21 | | -### LangChain Provider |
22 | | -**Package:** [`launchdarkly-server-sdk-ai-langchain`](./packages/langchain/) |
23 | | -**PyPI:** https://pypi.org/project/launchdarkly-server-sdk-ai-langchain/ |
24 | | - |
25 | | -LangChain provider supporting multiple AI providers through LangChain's unified interface. |
26 | | - |
27 | | -```bash |
28 | | -pip install launchdarkly-server-sdk-ai-langchain |
29 | | -``` |
30 | | - |
31 | | -## Installation |
32 | | - |
33 | | -### Basic Installation |
34 | | -```bash |
35 | | -# Install core SDK |
36 | | -pip install launchdarkly-server-sdk-ai |
37 | | - |
38 | | -# Install with LangChain provider |
39 | | -pip install launchdarkly-server-sdk-ai-langchain |
40 | | -``` |
41 | | - |
42 | | -### Development Installation |
43 | | -```bash |
44 | | -# Clone the repository |
45 | | -git clone https://github.com/launchdarkly/python-server-sdk-ai.git |
46 | | -cd python-server-sdk-ai |
47 | | - |
48 | | -# Install core package |
49 | | -cd packages/core |
50 | | -poetry install |
51 | | - |
52 | | -# Install langchain package (in separate terminal/session) |
53 | | -cd packages/langchain |
54 | | -poetry install |
55 | | -``` |
56 | | - |
57 | | -## Usage |
58 | | - |
59 | | -```python |
60 | | -from ldclient import init, Context |
61 | | -from ldai import init_ai |
62 | | - |
63 | | -# Initialize |
64 | | -ld_client = init('your-sdk-key') |
65 | | -ai_client = init_ai(ld_client) |
66 | | - |
67 | | -# Create a chat (automatically uses installed providers) |
68 | | -context = Context.create('user-key') |
69 | | -chat = await ai_client.create_chat('chat-config', context) |
70 | | - |
71 | | -if chat: |
72 | | - response = await chat.invoke('Hello!') |
73 | | - print(response.message.content) |
74 | | -``` |
75 | | - |
76 | | -## Documentation |
77 | | - |
78 | | -- [SDK Reference Guide](https://docs.launchdarkly.com/sdk/ai/python) |
79 | | -- [API Documentation](https://launchdarkly-python-sdk-ai.readthedocs.io/) |
80 | | -- [Core Package README](./packages/core/README.md) |
81 | | -- [LangChain Provider README](./packages/langchain/README.md) |
82 | | - |
83 | | -## Repository Structure |
84 | | - |
85 | | -``` |
86 | | -python-server-sdk-ai/ |
87 | | -├── packages/ |
88 | | -│ ├── core/ # Core SDK |
89 | | -│ │ ├── ldai/ # Main SDK code |
90 | | -│ │ ├── pyproject.toml |
91 | | -│ │ └── README.md |
92 | | -│ └── langchain/ # LangChain provider |
93 | | -│ ├── ldai/ |
94 | | -│ │ └── providers/ |
95 | | -│ │ └── langchain/ |
96 | | -│ ├── pyproject.toml |
97 | | -│ └── README.md |
98 | | -├── .github/ |
99 | | -│ └── workflows/ # CI/CD workflows |
100 | | -├── release-please-config.json # Multi-package release config |
101 | | -└── .release-please-manifest.json # Version tracking |
102 | | -``` |
103 | | - |
104 | | -## Publishing |
105 | | - |
106 | | -Each package is published independently to PyPI: |
107 | | -- Core: `launchdarkly-server-sdk-ai` |
108 | | -- LangChain: `launchdarkly-server-sdk-ai-langchain` |
109 | | - |
110 | | -Releases are managed automatically via Release Please when changes are merged to `main`. |
| 17 | +This repository contains the following packages: |
111 | 18 |
|
112 | | -## Contributing |
| 19 | +- **[`launchdarkly-server-sdk-ai`](./packages/core/)** - Core LaunchDarkly AI SDK |
| 20 | +- **[`launchdarkly-server-sdk-ai-langchain`](./packages/langchain/)** - LangChain provider integration |
113 | 21 |
|
114 | | -See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
| 22 | +Refer to each package's README for specific installation and usage instructions. |
| 23 | + |
| 24 | +## Getting started |
| 25 | + |
| 26 | +Refer to the [SDK reference guide](https://docs.launchdarkly.com/sdk/ai/python) for instructions on getting started with using the SDK. |
| 27 | + |
| 28 | +## Learn more |
| 29 | + |
| 30 | +Read our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [reference guide for the python SDK](http://docs.launchdarkly.com/docs/python-sdk-ai-reference). |
| 31 | + |
| 32 | +## Contributing |
115 | 33 |
|
116 | | -## Testing |
| 34 | +We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this library. |
117 | 35 |
|
118 | | -```bash |
119 | | -# Test core package |
120 | | -cd packages/core |
121 | | -poetry run pytest |
| 36 | +## Verifying library build provenance with the SLSA framework |
122 | 37 |
|
123 | | -# Test langchain package |
124 | | -cd packages/langchain |
125 | | -poetry run pytest |
126 | | -``` |
| 38 | +LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published library packages. To learn more, see the [provenance guide](PROVENANCE.md). |
127 | 39 |
|
128 | | -## License |
| 40 | +## About LaunchDarkly |
129 | 41 |
|
130 | | -Apache-2.0. See [LICENSE.txt](LICENSE.txt) |
| 42 | +- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can: |
| 43 | + - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases. |
| 44 | + - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?). |
| 45 | + - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file. |
| 46 | + - Grant access to certain features based on user attributes, like payment plan (eg: users on the 'gold' plan get access to more features than users in the 'silver' plan). Disable parts of your application to facilitate maintenance, without taking everything offline. |
| 47 | +- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list. |
| 48 | +- Explore LaunchDarkly |
| 49 | + - [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information |
| 50 | + - [docs.launchdarkly.com](https://docs.launchdarkly.com/ "LaunchDarkly Documentation") for our documentation and SDK reference guides |
| 51 | + - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ "LaunchDarkly API Documentation") for our API documentation |
| 52 | + - [blog.launchdarkly.com](https://blog.launchdarkly.com/ "LaunchDarkly Blog Documentation") for the latest product updates |
0 commit comments