From 8d0ce971133f591f2d6adde307d5c7acba82bead Mon Sep 17 00:00:00 2001 From: asonnenschein Date: Thu, 3 Oct 2024 12:09:13 -0400 Subject: [PATCH 1/3] doc updates --- CONTRIBUTING.md | 22 ++--------------- README.md | 46 ++++++++++++++++++----------------- docs/cli/cli-subscriptions.md | 3 +-- 3 files changed, 27 insertions(+), 44 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20ec8c90..09f6d5dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,13 +9,7 @@ document explains how to contribute successfully. #### Development Branch -Implementation of new features will be tracked in the `main` branch, while bug -fixes and doc changes for the latest release will be tracked in the maintenance -branch, called `maint-RELEASE_VERSION`. All work will be performed in a -new development branch starting with the appropriate base branch and merged -back into that branch. - -For new features: +The default branch is always `main` and should be always considered in-development. Feature enhancements, bug fixes, and other maintenance should be performed in a development branch, starting with the appropriate base branch and merged back into that branch: ```console git checkout main @@ -23,21 +17,9 @@ git pull git checkout -b new-branch-name ``` -For example, for bug fixes and doc changes to release version 2.0: - -```console -git checkout maint-2.0 -git pull -git checkout -b new-branch-name -``` - #### Branch Naming -Please use the following naming convention for development branches: - -`{up to 3-word summary of topic, separated by a dash)-{ticket number}` - -For example: `release-contributing-691` for [ticket 691](https://github.com/planetlabs/planet-client-python/issues/691). +Branch names should describe the work performed within the branch, and include a ticket number if applicable. For example, a branch that corrects typos in documentation and is not ticketed could be named `fix-documentation-typos`, and a branch that adds a new feature and is ticketed could be named `new-feature-123` (where 'new-feature' is the name of the feature and '-123' is the ticket number). ### Pull Requests diff --git a/README.md b/README.md index c4487f29..dd208e63 100644 --- a/README.md +++ b/README.md @@ -16,37 +16,44 @@ Version 2.0 includes support for the core workflows of the following APIs: After the initial 2.0 release there will be additional work to support the remaining Planet APIs: [basemaps](https://developers.planet.com/docs/basemaps/), -[tasking](https://developers.planet.com/docs/tasking/)) and +[tasking](https://developers.planet.com/docs/tasking/) and [analytics](https://developers.planet.com/docs/analytics/). ## Versions and Stability -The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and therefore only major releases should break compatibility. Minor versions may include new functionality and patch versions address bugs or trivial changes (like documentation). +The default branch (main) of this repo is for the [Planet SDK for +Python](https://github.com/planetlabs/planet-client-python/projects/2), +a complete rewrite and upgrade from the original [Planet Python +Client](https://developers.planet.com/docs/pythonclient/). If you +are looking for the source code to that library see the +[v1](https://github.com/planetlabs/planet-client-python/tree/v1) branch. -If depending upon official packages from PyPI, a developer should feel comfortable specifying `planet == 2.*` unless depending on a specific feature introduced at a minor version, in which case `planet == 2.x.*` (where x is the minor version of the new feature) should suffice. - -The default branch is always `main` and should be considered in-development but with tests and other build steps succeeding. +The Planet SDK for Python is in 'pre-release' stages, working towards a solid +beta release in December. Upcoming milestones are tracked in the [Planet SDK +for Python Milestones](https://github.com/planetlabs/planet-client-python/milestones). ## Installation and Quick Start -The main installation path and first steps are found in the -[Quick Start Guide](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/quick-start-guide/) -of the documentation. - -### Installing from source +The Planet SDK for Python is [hosted on PyPI](https://pypi.org/project/planet/) and can simply be installed via: -This option enables you to get all the latest changes, but things might also be a bit less stable. -To install you must [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) -the [planet-client-python](https://github.com/planetlabs/planet-client-python) repository -to your local computer. After you have the repo local just navigate to the root -directory, where this readme lives. +```console +pip install planet +``` -Then you can install locally with pip: +To install from source, first clone this repository, then navigate to the root directory (where `setup.py` lives) and run: ```console -$ pip install . +pip install . ``` +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. + +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. + +## Contributing and Development + +To contribute or develop with this library, see [CONTRIBUTING.md](CONTRIBUTING.md). + ## Documentation Documentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/) @@ -58,8 +65,3 @@ read from source in the [docs](/docs) directory. Planet's APIs require an account for use. To get started you need to [Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/). - -## Development - -To contribute or develop with this library, see -[CONTRIBUTING.md](CONTRIBUTING.md). diff --git a/docs/cli/cli-subscriptions.md b/docs/cli/cli-subscriptions.md index c13cdb61..9f7801ec 100644 --- a/docs/cli/cli-subscriptions.md +++ b/docs/cli/cli-subscriptions.md @@ -171,8 +171,7 @@ You can also filter by status: planet subscriptions results SUBSCRIPTION_ID --status processing ``` -The available statuses are `created`, `queued`, `processing`, `failed`, and `success`. Note it’s quite useful -to use `jq` to help filter out results as well. +See the Subscriptions API documentation for the [official list of available statuses](https://developers.planet.com/docs/subscriptions/#subscription-status). #### Results as comma-separated values (CSV) From ae1aea078d33c91fe55a5be934f1bcd12b146e24 Mon Sep 17 00:00:00 2001 From: asonnenschein Date: Thu, 17 Oct 2024 11:14:19 -0400 Subject: [PATCH 2/3] rebase --- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index dd208e63..0a2385b7 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,11 @@ remaining Planet APIs: [basemaps](https://developers.planet.com/docs/basemaps/), ## Versions and Stability -The default branch (main) of this repo is for the [Planet SDK for -Python](https://github.com/planetlabs/planet-client-python/projects/2), -a complete rewrite and upgrade from the original [Planet Python -Client](https://developers.planet.com/docs/pythonclient/). If you -are looking for the source code to that library see the -[v1](https://github.com/planetlabs/planet-client-python/tree/v1) branch. - -The Planet SDK for Python is in 'pre-release' stages, working towards a solid -beta release in December. Upcoming milestones are tracked in the [Planet SDK -for Python Milestones](https://github.com/planetlabs/planet-client-python/milestones). +The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and therefore only major releases should break compatibility. Minor versions may include new functionality and patch versions address bugs or trivial changes (like documentation). + +If depending upon official packages from PyPI, a developer should feel comfortable specifying `planet == 2.*` unless depending on a specific feature introduced at a minor version, in which case `planet == 2.x.*` (where x is the minor version of the new feature) should suffice. + +The default branch is always `main` and should be considered in-development but with tests and other build steps succeeding. ## Installation and Quick Start From 6bcdc1866b751dc99d31da3192d8c4321723a9f9 Mon Sep 17 00:00:00 2001 From: asonnenschein Date: Thu, 17 Oct 2024 11:20:28 -0400 Subject: [PATCH 3/3] update setup.py --- setup.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index a7c8294f..8f3aef88 100644 --- a/setup.py +++ b/setup.py @@ -63,9 +63,9 @@ 'Topic :: Utilities' ], keywords='planet api sdk client', - author='Jennifer Reiber Kyle', - maintainer='Planet Dev Rel Team', - maintainer_email='developers@planet.com', + author='Planet', + maintainer='Planet', + maintainer_email='python-sdk-contributors@planet.com', url='https://github.com/planetlabs/planet-client-python', license='Apache 2.0', packages=find_packages(exclude=['examples', 'tests']),