Skip to content

Commit

Permalink
[PYG-332] 🤩 Prepare v1 (#427)
Browse files Browse the repository at this point in the history
* refactor: remove beta note

* build: changelog

* style;

* build: bump major

* fix: update docs
  • Loading branch information
doctrino authored Jan 31, 2025
1 parent aa3feca commit 713e4f3
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 22 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,6 @@ Cognite Python SDK Generator
This is the Cognite Python SDK Generator, `pygen`. The purpose of this package is to help developers to
work with Cognite Data Fusion's (CDF) Data Models (DM) in Python.

**Beta Note** This package, `pygen`, is currently in beta, which is reflected in the version number `0.99.x`. Beta
indicates that a product or functionality is in a mature testing phase, but is still subject to change or retirement.
We will provide a deprecation notice a minimum of two months before retiring the product or functionality. We recommend
not using the product or functionality in production systems.

The core functionality is to provide a Python client that matches a data model. This enables the developer for the following
benefits

Expand Down
2 changes: 1 addition & 1 deletion cognite/pygen/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.99.63"
__version__ = "1.0.0"
5 changes: 5 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Changes are grouped as follows
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.


## [1.0.0] - 2025-01-31
## Removed
- All deprecated features/classes have been removed.

## [0.99.63] - 2025-01-31
### Changed
- In the `generate_sdk`, the `format_code` parameter is now default to `False`. In addition, in the
Expand Down
5 changes: 0 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@
This is the Cognite Python SDK Generator, `pygen`. The purpose of this package is to help developers to
work with Cognite Data Fusion's (CDF) Data Models (DM) in Python.

**Beta Note** This package, `pygen`, is currently in beta, which is reflected in the version number `0.99.x`. Beta
indicates that a product or functionality is in a mature testing phase, but is still subject to change or retirement.
We will provide a deprecation notice a minimum of two months before retiring the product or functionality. We recommend
not using the product or functionality in production systems.

The core functionality is to provide a Python client that matches a data model. This enables the developer for the following
benefits

Expand Down
4 changes: 2 additions & 2 deletions examples/cognite_core/_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class CogniteCoreClient:
CogniteCoreClient
Generated with:
pygen = 0.99.63
pygen = 1.0.0
cognite-sdk = 7.70.7
pydantic = 2.10.4
Expand All @@ -70,7 +70,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
else:
raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
# The client name is used for aggregated logging of Pygen Usage
client.config.client_name = "CognitePygen:0.99.63"
client.config.client_name = "CognitePygen:1.0.0"

self._client = client

Expand Down
4 changes: 2 additions & 2 deletions examples/omni/_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class OmniClient:
OmniClient
Generated with:
pygen = 0.99.63
pygen = 1.0.0
cognite-sdk = 7.70.7
pydantic = 2.10.4
Expand All @@ -61,7 +61,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
else:
raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
# The client name is used for aggregated logging of Pygen Usage
client.config.client_name = "CognitePygen:0.99.63"
client.config.client_name = "CognitePygen:1.0.0"

self._client = client

Expand Down
4 changes: 2 additions & 2 deletions examples/omni_multi/_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class OmniMultiClient:
OmniMultiClient
Generated with:
pygen = 0.99.63
pygen = 1.0.0
cognite-sdk = 7.70.7
pydantic = 2.10.4
Expand All @@ -127,7 +127,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
else:
raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
# The client name is used for aggregated logging of Pygen Usage
client.config.client_name = "CognitePygen:0.99.63"
client.config.client_name = "CognitePygen:1.0.0"

self.omni_multi_a = OmniMultiAAPIs(client)
self.omni_multi_b = OmniMultiBAPIs(client)
Expand Down
4 changes: 2 additions & 2 deletions examples/omni_sub/_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class OmniSubClient:
OmniSubClient
Generated with:
pygen = 0.99.63
pygen = 1.0.0
cognite-sdk = 7.70.7
pydantic = 2.10.4
Expand All @@ -43,7 +43,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
else:
raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
# The client name is used for aggregated logging of Pygen Usage
client.config.client_name = "CognitePygen:0.99.63"
client.config.client_name = "CognitePygen:1.0.0"

self._client = client

Expand Down
4 changes: 2 additions & 2 deletions examples/wind_turbine/_api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class WindTurbineClient:
WindTurbineClient
Generated with:
pygen = 0.99.63
pygen = 1.0.0
cognite-sdk = 7.70.7
pydantic = 2.10.4
Expand All @@ -55,7 +55,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
else:
raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
# The client name is used for aggregated logging of Pygen Usage
client.config.client_name = "CognitePygen:0.99.63"
client.config.client_name = "CognitePygen:1.0.0"

self._client = client

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "cognite-pygen"
version = "0.99.63"
version = "1.0.0"
description = "Cognite Python SDK Generator"
readme = "README.md"
authors = ["Cognite <[email protected]>"]
Expand Down

0 comments on commit 713e4f3

Please sign in to comment.