Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc updates #1062

Merged
merged 3 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 2 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,17 @@ 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
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

Expand Down
33 changes: 15 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ 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
Expand All @@ -29,24 +29,26 @@ The default branch is always `main` and should be considered in-development but

## 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.
The Planet SDK for Python is [hosted on PyPI](https://pypi.org/project/planet/) and can simply be installed via:

### Installing from source

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/)
Expand All @@ -58,8 +60,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).
3 changes: 1 addition & 2 deletions docs/cli/cli-subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']),
Expand Down
Loading