Skip to content

Commit 93f1e6f

Browse files
paulkrsagoez
andauthored
chore: rebrand documentation to pica (#215)
Co-authored-by: Samuel Gomez <[email protected]>
1 parent 6663e3a commit 93f1e6f

File tree

14 files changed

+79
-66
lines changed

14 files changed

+79
-66
lines changed

README.md

+29-34
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
<p align="center">
2-
📖 Just launched <b><a href="https://www.integrationos.com/">IntegrationOS</a></b>
3-
<br/>
4-
</p>
5-
6-
<p align="center">
7-
<a href="https://integrationos.com">
8-
<img src="https://assets-global.website-files.com/5f6b97302bb70b93e591d51f/657a3a1aec47c8ec20b396fe_IntegrationOS%20main%20logo-p-500.png" height="64px">
2+
<a href="https://picaos.com">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="./resources/images/logo-dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="./resources/images/logo-light.svg">
6+
<img alt="Pica Logo" src="./resources/images/logo-light.svg" height="100px">
7+
</picture>
98
</a>
109
</p>
1110

12-
<p align="center"><b>Ship integrations, remarkably fast.</b></p>
11+
<p align="center"><b>The Complete Agentic Infrastructure</b></p>
1312

1413
<p align="center">
1514
<b>
16-
<a href="https://www.integrationos.com/">Website</a>
17-
·
18-
<a href="https://docs.integrationos.com/docs/quickstart">Documentation</a>
15+
<a href="https://www.picaos.com/">Website</a>
1916
·
20-
<a href="https://www.integrationos.com/changelog">Changelog</a>
17+
<a href="https://docs.picaos.com">Documentation</a>
2118
·
22-
<a href="https://www.integrationos.com/blog">Blog</a>
19+
<a href="https://www.picaos.com/community">Community Hub</a>
2320
·
24-
<a href="https://join.slack.com/t/integrationos-hq/shared_invite/zt-2dm9254tc-Eza~78acJllbP7ZFKuVYjw">Slack</a>
21+
<a href="https://www.picaos.com/community/changelog">Changelog</a>
2522
·
26-
<a href="https://twitter.com/integrationos">Twitter</a>
23+
<a href="https://twitter.com/picahq">Twitter</a>
2724
</b>
2825
</p>
2926

@@ -38,39 +35,39 @@ Forget the pain of having to manually parse through, transform and maintain hund
3835

3936
To get the most out of this guide, you'll need:
4037

41-
1. An [IntegrationOS account](https://app.integrationos.com)
42-
2. Your IntegrationOS [API Key](https://docs.integrationos.com/docs/glossary#api-key)
38+
1. A [Pica account](https://app.picaos.com)
39+
2. Your Pica [API Key](https://docs.picaos.com/docs/glossary#api-key)
4340

4441
## Step 1: Backend - Create secure tokens
4542

4643
First, we'll add an endpoint to our backend that'll let us generate secure tokens for our frontend component.
4744

4845
### Install the SDK
4946

50-
To make this easy, IntegrationOS offers native SDKs in several popular programming languages. This guide will use the popular AuthKit SDK for Node.js.
47+
To make this easy, Pica offers native SDKs in several popular programming languages. This guide will use the popular AuthKit SDK for Node.js.
5148

5249
```shell npm
53-
npm install @integrationos/authkit-node
50+
npm install @picahq/authkit-node
5451
```
5552

5653
### Set secrets
5754

58-
To make calls to IntegrationOS, provide your API key. Store these values as managed secrets and pass them to the SDKs either as environment variables or directly in your app's configuration depending on your preferences.
55+
To make calls to Pica, provide your API key. Store these values as managed secrets and pass them to the SDKs either as environment variables or directly in your app's configuration depending on your preferences.
5956

6057
```shell
61-
INTEGRATIONOS_SANDBOX_API_KEY='sk_test_example_123456789'
62-
INTEGRATIONOS_PRODUCTION_API_KEY='sk_live_example_123456789'
58+
PICA_SANDBOX_API_KEY='sk_test_example_123456789'
59+
PICA_PRODUCTION_API_KEY='sk_live_example_123456789'
6360
```
6461

6562
### Create a token endpoint
6663

6764
Next, we'll need to add the token endpoint which will exchange the authorization token (valid for 10 minutes) for an authenticated Connected Account.
6865

6966
```javascript
70-
import { AuthKitToken } from "@integrationos/authkit-node";
67+
import { AuthKitToken } from "@picahq/authkit-node";
7168

7269
app.post("/authkit-token", async (request, response) => {
73-
const authKitToken = new AuthKitToken(process.env.INTEGRATIONOS_SANDBOX_API_KEY);
70+
const authKitToken = new AuthKitToken(process.env.PICA_SANDBOX_API_KEY);
7471

7572
// Specifying how the token will be constructed
7673
const token = await authKitToken.create({
@@ -89,18 +86,18 @@ Next, we'll add the AuthKit component to your frontend application.
8986

9087
### Install the SDK
9188

92-
In the same fashion, IntegrationOS offers native frontend SDKs in several popular frameworks. Compatible with React, Next.js, Vue, Svelte and more.
89+
In the same fashion, Pica offers native frontend SDKs in several popular frameworks. Compatible with React, Next.js, Vue, Svelte and more.
9390

9491
```shell npm
95-
npm install @integrationos/authkit
92+
npm install @picahq/authkit
9693
```
9794

9895
### Use the AuthKit Component
9996

10097
Next, we need to add the AuthKit component and replace the token URL with the URL of the token endpoint URL you created in Step 1 of this guide.
10198

10299
```javascript
103-
import { useAuthKit } from "@integrationos/authkit";
100+
import { useAuthKit } from "@picahq/authkit";
104101

105102
const { open } = useAuthKit({
106103
token: {
@@ -129,15 +126,13 @@ This will open the AuthKit modal so your user can:
129126

130127
Once the flow is completed, AuthKit will return a Connection object to your onSuccess callback. Each connection object contains metadata about the connected account and can be used to make API requests.
131128

132-
View the full guide [here](https://docs.integrationos.com/docs/quickstart).
129+
View the full guide [here](https://docs.picaos.com).
133130

134-
# Running IntegrationOS locally
131+
# Running Pica locally
135132

136133
## Prerequisites
137134

138135
* [Docker](https://docs.docker.com/engine/) and [Docker Compose](https://docs.docker.com/compose/)
139-
* A [Google Cloud KMS](https://cloud.google.com/kms/docs) key ring
140-
* [`gcloud`](https://cloud.google.com/sdk/gcloud) installed, logged into an account that has `roles/cloudkms.cryptoKeyEncrypterDecrypter` access, and configured with [Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc)
141136

142137
## Setup
143138

@@ -156,18 +151,18 @@ View the full guide [here](https://docs.integrationos.com/docs/quickstart).
156151
docker compose -f docker-compose.data.yml run --rm seed-data
157152
```
158153

159-
**Note:** If you want to run the latest version of the docker image, you can use the latest git commit hash as the tag. For example, `integrationos/integrationos:<commit-hash>`.
154+
**Note:** If you want to run the latest version of the docker image, you can use the latest git commit hash as the tag. For example, `picahq/pica:<commit-hash>`.
160155

161156
## Other actions
162157

163158
Connecting to a MongoDB shell
164159

165160
```shell
166161
source .env
167-
docker compose exec mongo mongosh -u integrationos -p $MONGO_PASSWORD --authenticationDatabase=admin events-service
162+
docker compose exec mongo mongosh -u pica -p $MONGO_PASSWORD --authenticationDatabase=admin events-service
168163
```
169164

170165

171166
# License
172167

173-
IntegrationOS is released under the [**GPL-3.0 license**](LICENSE).
168+
Pica is released under the [**GPL-3.0 license**](LICENSE).

docker-compose.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
services:
22
typescript-services:
33
platform: linux/amd64
4-
image: us-docker.pkg.dev/integrationos/docker-oss/typescript-services:1.24.0
4+
image: us-docker.pkg.dev/pica/docker-oss/typescript-services:1.24.0
55
ports:
66
- 3001:3001
77
environment:
@@ -27,7 +27,7 @@ services:
2727

2828
connections-api:
2929
platform: linux/amd64
30-
image: us-docker.pkg.dev/integrationos/docker-oss/api:1.24.0
30+
image: us-docker.pkg.dev/pica/docker-oss/api:1.24.0
3131
ports:
3232
- 3005:3005
3333
environment:
@@ -57,7 +57,7 @@ services:
5757

5858
event-core:
5959
platform: linux/amd64
60-
image: us-docker.pkg.dev/integrationos/docker-oss/event-core:1.24.0
60+
image: us-docker.pkg.dev/pica/docker-oss/event-core:1.24.0
6161
environment:
6262
- CONTEXT_COLLECTION_NAME=event-transactions
6363
- CONTEXT_DATABASE_NAME=events-service
@@ -80,7 +80,7 @@ services:
8080

8181
gateway:
8282
platform: linux/amd64
83-
image: us-docker.pkg.dev/integrationos/docker-oss/gateway:1.24.0
83+
image: us-docker.pkg.dev/pica/docker-oss/gateway:1.24.0
8484
ports:
8585
- 3002:3002
8686
environment:
@@ -98,7 +98,7 @@ services:
9898

9999
oauth-refresh:
100100
platform: linux/amd64
101-
image: us-docker.pkg.dev/integrationos/docker-oss/oauth-refresh:1.24.0
101+
image: us-docker.pkg.dev/pica/docker-oss/oauth-refresh:1.24.0
102102
ports:
103103
- 3003:3003
104104
environment:
@@ -124,7 +124,7 @@ services:
124124

125125
watchdog:
126126
platform: linux/amd64
127-
image: us-docker.pkg.dev/integrationos/docker-oss/watchdog:1.24.0
127+
image: us-docker.pkg.dev/pica/docker-oss/watchdog:1.24.0
128128
environment:
129129
- CONTEXT_COLLECTION_NAME=event-transactions
130130
- CONTEXT_DATABASE_NAME=events-service

integrationos-api/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## IntegrationOS API
1+
## Pica API
22

3-
Common API for the IntegrationOS project.
3+
Common API for the Pica project.
44

55
For a full list of endpoints, please refer to the following files:
66

integrationos-archiver/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# IntegrationOS Archiver
1+
# Pica Archiver
22

3-
A Rust-based archiver for the IntegrationOS project that archives the specified database.
3+
A Rust-based archiver for the Pica project that archives the specified database.
44

55
## Purpose
66

7-
IntegrationOS Archiver is a service designed to archive data from a specified database efficiently. It is built using Rust to ensure high performance and reliability in handling large volumes of data.
7+
Pica Archiver is a service designed to archive data from a specified database efficiently. It is built using Rust to ensure high performance and reliability in handling large volumes of data.
88

99
## Running the Archiver
1010

integrationos-cache/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# IntegrationOS Cache
1+
# Pica Cache
22

3-
A minimal wrapper around Moka and Redis for caching in the IntegrationOS project.
3+
A minimal wrapper around Moka and Redis for caching in the Pica project.
44

55
## Purpose
66

7-
IntegrationOS Cache provides a lightweight, minimalistic interface to manage caching operations using Moka and Redis. While it is not runnable as a standalone service, it can be integrated into other systems and thoroughly tested to ensure reliable caching behavior.
7+
Pica Cache provides a lightweight, minimalistic interface to manage caching operations using Moka and Redis. While it is not runnable as a standalone service, it can be integrated into other systems and thoroughly tested to ensure reliable caching behavior.
88

99
## Running the Tests
1010

integrationos-database/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# IntegrationOS Storage
1+
# Pica Storage
22

3-
A versatile wrapper around multiple storage solutions, designed for single-tenant management of clients in the IntegrationOS project.
3+
A versatile wrapper around multiple storage solutions, designed for single-tenant management of clients in the Pica project.
44

55
## Purpose
66

7-
IntegrationOS Storage provides a unified interface for managing different storage backends, enabling single-tenant configurations for clients. It supports seamless integration of new databases, making it adaptable to various storage needs.
7+
Pica Storage provides a unified interface for managing different storage backends, enabling single-tenant configurations for clients. It supports seamless integration of new databases, making it adaptable to various storage needs.
88

99
## Running the Storage Service
1010

integrationos-domain/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# IntegrationOS Domain
1+
# Pica Domain
22

33
This documentation does not aim to be an in-depth explanation of the code, but rather a high-level overview of the project.
44
For a more detailed explanation, please refer to the code itself.
55

66
## Overview
77

8-
IntegrationOS domain seeks to hold the common data structures used on the [integration-os](https://github.com/integration-os/integration-os) repository. Along with these DS, it also
8+
Pica domain seeks to hold the common data structures used on the [pica](https://github.com/picahq/pica) repository. Along with these DS, it also
99
has some utilities to create `id` and manipulate `json` as well as general purpose services.
1010

1111
### Environment Variables
@@ -40,14 +40,14 @@ The following environment variables are introduced, not necessarily used, by thi
4040

4141
### Services
4242

43-
- Caller Client: A client to make requests to external APIs. It is used to make requests to external APIs and return the response. It is used by the `integration-os` repository to make requests to external APIs.
44-
- Secrets Client: A client to interact with the secrets service. It is used to get and create secrets in the secrets service. It is used by the `integration-os` repository to get and create secrets.
45-
- Watchdog Client: A client to start and stop the watchdog service. It is used to start the watchdog service. It is used by the `integration-os` repository to start and stop the watchdog service.
43+
- Caller Client: A client to make requests to external APIs. It is used to make requests to external APIs and return the response. It is used by the `pica` repository to make requests to external APIs.
44+
- Secrets Client: A client to interact with the secrets service. It is used to get and create secrets in the secrets service. It is used by the `pica` repository to get and create secrets.
45+
- Watchdog Client: A client to start and stop the watchdog service. It is used to start the watchdog service. It is used by the `pica` repository to start and stop the watchdog service.
4646

4747
### Data Structures
4848

4949
Please refer to the code itself for a detailed explanation of the data structures.
5050

5151
### Utilities
5252

53-
- Hash Data: A utility to hash data. It is used to hash data and return the hash. It is used by the `integration-os` repository to hash data.
53+
- Hash Data: A utility to hash data. It is used to hash data and return the hash. It is used by the `pica` repository to hash data.

integrationos-event/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IntegrationOS Event
1+
# Pica Event
22

33
Processes incoming events from the [gateway](../integrationos-gateway/) over redis and executes the associated pipelines.
44

integrationos-gateway/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# IntegrationOS Gateway
1+
# Pica Gateway
22

33
Receives events by POSTing to the `/emit/:access_key` endpoint. Validates the access key and then stores the event in mongodb and transmits it over redis.
44

55
## Dependencies
66

7-
Requires redis to send events to the [integrationos-event](../integrationos-event) service.
7+
Requires redis to send events to the [pica-event](../integrationos-event) service.
88

99
```bash
1010
$ docker run -p 6379:6379 redis

integrationos-oauth/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IntegrationOS OAuth API
1+
# Pica OAuth API
22

33
The API for OAuth based Connections.
44

integrationos-oauth/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@
3939
"eslint-plugin-prettier": "^4.2.1",
4040
"prettier": "^2.7.1"
4141
}
42-
}
42+
}

integrationos-unified/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# IntegrationOS Unified
1+
# Pica Unified
22

3-
The core logic for unification APIs and user request handling in the IntegrationOS project.
3+
The core logic for unification APIs and user request handling in the Pica project.
44

55
## Purpose
66

7-
IntegrationOS Unified provides the core functionality for managing and processing unification APIs, ensuring proper handling of user requests across the IntegrationOS ecosystem. While this service is not directly runnable, its logic forms the backbone of the unification process within the system.
7+
Pica Unified provides the core functionality for managing and processing unification APIs, ensuring proper handling of user requests across the Pica ecosystem. While this service is not directly runnable, its logic forms the backbone of the unification process within the system.
88

9-
For detailed usage and API references, visit the [API documentation](https://docs.integrationos.com/reference/list-connections).
9+
For detailed usage and API references, visit the [API documentation](https://docs.picaos.com).
1010

1111
## Running the Tests
1212

0 commit comments

Comments
 (0)