Skip to content

Commit 41fcf0d

Browse files
Merge pull request #1167 from planetlabs/carl/3.0--release-update
3.0 release updates
2 parents 1e58f02 + 473bbce commit 41fcf0d

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The [Planet](https://planet.com) Software Development Kit (SDK) for Python
77
provides both a Python API and a command-line interface (CLI)
88
to make use of [the Planet APIs](https://docs.planet.com/develop/apis/).
99
Everything you need to get started is found in our
10-
[online documentation](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/).
10+
[online documentation](https://planet-sdk-for-python.readthedocs.io/en/latest/).
1111

1212
Version 2.0 includes support for the core workflows of the following APIs:
1313

@@ -33,7 +33,7 @@ with semantic version identifiers that comply with [PEP 440](https://peps.python
3333
The Semantic Versioning stability scheme only applies to APIs that
3434
are considered part of the public API. This includes library APIs exported
3535
from the `planet` package and documented in our
36-
[SDK developer documentation](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/),
36+
[SDK developer documentation](https://planet-sdk-for-python.readthedocs.io/en/latest/),
3737
and the `planet` CLI interface used for scripts. It does not include
3838
library interfaces below the top level `planet` Python package which are
3939
considered internal and subject to change without notice.
@@ -81,11 +81,11 @@ See [CONTRIBUTING.md](CONTRIBUTING.md#branches) for more information on branches
8181

8282
##### Current Mainline Versions and Branches
8383

84-
| Version | Status | Branch | Documentation | Initial Release | End of Active Development | End of Maintenance | Notes |
85-
|---------|---------------|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|-----------------|---------------------------|--------------------|-------------------------------------------------------------------------------------------------|
86-
| 3.x | `development` | [`main-3.0-dev`](https://github.com/planetlabs/planet-client-python/tree/main-3.0-dev) | [Planet Labs Python Client on ReadTheDocs.io](https://planet-sdk-for-python.readthedocs.io/en/latest/) | TBD | TBD | TBD | See [3.0.0 Release Milestone](https://github.com/planetlabs/planet-client-python/milestone/31). |
87-
| 2.x | `active` | [`main`](https://github.com/planetlabs/planet-client-python/tree/main) | [Planet Labs Python Client v2 on ReadTheDocs.io](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/) | April 2023 | TBD | TBD | |
88-
| 1.x | `end-of-life` | [`v1`](https://github.com/planetlabs/planet-client-python/tree/v1) | [Planet Labs Python Client v1 on Github.io](https://planetlabs.github.io/planet-client-python/) | April 2017 | April 2023 | TBD | |
84+
| Version | Status | Branch | Documentation | Initial Release | End of Active Development | End of Maintenance | Notes |
85+
|---------|---------------|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|-----------------------|---------------------------|--------------------|-------------------------------------------------------------------------------------------------|
86+
| 3.x | `development` | [`main-3.0-dev`](https://github.com/planetlabs/planet-client-python/tree/main-3.0-dev) | [Planet Labs Python Client on ReadTheDocs.io](https://planet-sdk-for-python.readthedocs.io/en/latest/) | Targeting August 2025 | TBD | TBD | See [3.0.0 Release Milestone](https://github.com/planetlabs/planet-client-python/milestone/31). |
87+
| 2.x | `active` | [`main`](https://github.com/planetlabs/planet-client-python/tree/main) | [Planet Labs Python Client v2 on ReadTheDocs.io](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/) | April 2023 | TBD | TBD | |
88+
| 1.x | `end-of-life` | [`v1`](https://github.com/planetlabs/planet-client-python/tree/v1) | [Planet Labs Python Client v1 on Github.io](https://planetlabs.github.io/planet-client-python/) | April 2017 | April 2023 | TBD | |
8989

9090
## Installation and Quick Start
9191

@@ -103,20 +103,20 @@ pip install .
103103

104104
Note that the above commands will install the Planet SDK into the global system Python unless a virtual environment is enabled. For more information on configuring a virtual environment from system Python, see the official Python [venv](https://docs.python.org/3/library/venv.html) documentation. For users who are running multiple versions of Python via [pyenv](https://github.com/pyenv/pyenv), see the [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) extension documentation.
105105

106-
Detailed installation instructions for the Planet SDK can be found in the [Quick Start Guide](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/quick-start-guide/) of the documentation.
106+
Detailed installation instructions for the Planet SDK can be found in the [Quick Start Guide](https://planet-sdk-for-python.readthedocs.io/en/latest/get-started/quick-start-guide/) of the documentation.
107107

108108
## Contributing and Development
109109

110110
To contribute or develop with this library, see [CONTRIBUTING.md](CONTRIBUTING.md).
111111

112112
## Documentation
113113

114-
Documentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/)
114+
Documentation is currently [hosted online](https://planet-sdk-for-python.readthedocs.io/en/latest/)
115115
It should be considered 'in progress', with many updates to come. It can also
116116
be built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be
117117
read from source in the [docs](/docs) directory.
118118

119119
## Authentication
120120

121121
Planet's APIs require an account for use. To get started you need to
122-
[Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/).
122+
[Get a Planet Account](https://planet-sdk-for-python.readthedocs.io/en/latest/get-started/get-your-planet-account/).

docs/resources/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ To contribute or develop with this library, see
4343

4444
## Version 1 of this SDK
4545

46-
[Version 1 of this SDK](https://github.com/planetlabs/planet-client-python/tree/1.5.2) is significantly different (see the [documentation](https://planet-sdk-for-python.readthedocs.io/en/latest/)). Version 2 is not backward compatible. Make sure to create a separate virtual environment if you need to work with both versions. For more information on how to do this, see the [Virtual Environments and the Planet SDK for Python](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/venv-tutorial/).
46+
[Version 1 of this SDK](https://github.com/planetlabs/planet-client-python/tree/1.5.2) is significantly different (see the [documentation](https://planet-sdk-for-python.readthedocs.io/en/latest/)). Version 2 was not backward compatible. Make sure to create a separate virtual environment if you need to work with both versions. For more information on how to do this, see the [Virtual Environments and the Planet SDK for Python](https://planet-sdk-for-python.readthedocs.io/en/latest/get-started/venv-tutorial/).

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: Planet SDK for Python
2-
site_url: https://planet-sdk-for-python-v2.readthedocs.io/en/latest/
2+
site_url: https://planet-sdk-for-python.readthedocs.io/en/latest/
33
site_author: https://docs.planet.com
44
site_description: >-
55
A Python library to discover and retrieve earth observation data from Planet Labs PBC.

0 commit comments

Comments
 (0)