Skip to content

Commit 665ca23

Browse files
authored
Update README and license headers (#10)
Changes ======= * Update README to reflect correct PyPI install * Update repo project in API docs and README * Update (or add) license headers
1 parent ca58a17 commit 665ca23

131 files changed

Lines changed: 432 additions & 127 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,25 @@ The Analytics SDK supports static typing. Currently only [mypy](https://github.
77

88
# Installing the SDK<a id="installing-the-sdk"></a>
99

10-
Until a version is available on PyPI, the SDK can be installed via pip with the following command (note the `dev` branch in the url).
10+
>Note: It is strongly recommended to update pip, setuptools and wheel prior to installing the SDK: `python3 -m pip install --upgrade pip setuptools wheel`
1111
1212
Install the SDK via `pip`:
1313
```console
14-
python3 -m pip install git+https://github.com/couchbaselabs/analytics-python-client@dev
14+
python3 -m pip install couchbase-analytics
15+
```
16+
17+
# Installing the SDK from source
18+
19+
The SDK can be installed from source via pip with the following command.
20+
21+
Install the SDK via `pip`:
22+
```console
23+
python3 -m pip install git+https://github.com/couchbase/analytics-python-client.git
1524
```
1625

1726
# Using the SDK<a id="using-the-sdk"></a>
1827

19-
Some more examples are provided in the [examples directory](https://github.com/couchbaselabs/analytics-python-client/tree/dev/examples).
28+
Some more examples are provided in the [examples directory](https://github.com/couchbase/analytics-python-client/tree/main/examples).
2029

2130
**Connecting and executing a query**
2231
```python

acouchbase_analytics/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");

acouchbase_analytics/cluster.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from __future__ import annotations
1718

1819
import sys

acouchbase_analytics/cluster.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");

acouchbase_analytics/credential.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,4 +13,5 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from couchbase_analytics.common.credential import Credential as Credential # noqa: F401

acouchbase_analytics/database.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from __future__ import annotations
1718

1819
import sys

acouchbase_analytics/database.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");

acouchbase_analytics/deserializer.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from couchbase_analytics.common.deserializer import DefaultJsonDeserializer as DefaultJsonDeserializer # noqa: F401
1718
from couchbase_analytics.common.deserializer import Deserializer as Deserializer # noqa: F401
1819
from couchbase_analytics.common.deserializer import PassthroughDeserializer as PassthroughDeserializer # noqa: F401

acouchbase_analytics/errors.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from couchbase_analytics.common.errors import AnalyticsError as AnalyticsError # noqa: F401
1718
from couchbase_analytics.common.errors import InternalSDKError as InternalSDKError # noqa: F401
1819
from couchbase_analytics.common.errors import InvalidCredentialError as InvalidCredentialError # noqa: F401

acouchbase_analytics/options.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2016-2024. Couchbase, Inc.
1+
# Copyright 2016-2025. Couchbase, Inc.
22
# All Rights Reserved.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +13,7 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515

16+
1617
from couchbase_analytics.common.options import ClusterOptions as ClusterOptions # noqa: F401
1718
from couchbase_analytics.common.options import ClusterOptionsKwargs as ClusterOptionsKwargs # noqa: F401
1819
from couchbase_analytics.common.options import QueryOptions as QueryOptions # noqa: F401

0 commit comments

Comments
 (0)