You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-20Lines changed: 2 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -9,35 +9,17 @@ document explains how to contribute successfully.
9
9
10
10
#### Development Branch
11
11
12
-
Implementation of new features will be tracked in the `main` branch, while bug
13
-
fixes and doc changes for the latest release will be tracked in the maintenance
14
-
branch, called `maint-RELEASE_VERSION`. All work will be performed in a
15
-
new development branch starting with the appropriate base branch and merged
16
-
back into that branch.
17
-
18
-
For new features:
12
+
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:
19
13
20
14
```console
21
15
git checkout main
22
16
git pull
23
17
git checkout -b new-branch-name
24
18
```
25
19
26
-
For example, for bug fixes and doc changes to release version 2.0:
27
-
28
-
```console
29
-
git checkout maint-2.0
30
-
git pull
31
-
git checkout -b new-branch-name
32
-
```
33
-
34
20
#### Branch Naming
35
21
36
-
Please use the following naming convention for development branches:
37
-
38
-
`{up to 3-word summary of topic, separated by a dash)-{ticket number}`
39
-
40
-
For example: `release-contributing-691` for [ticket 691](https://github.com/planetlabs/planet-client-python/issues/691).
22
+
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).
The Planet SDK for Python is [hosted on PyPI](https://pypi.org/project/planet/) and can simply be installed via:
40
38
41
-
### Installing from source
42
-
43
-
This option enables you to get all the latest changes, but things might also be a bit less stable.
44
-
To install you must [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
45
-
the [planet-client-python](https://github.com/planetlabs/planet-client-python) repository
46
-
to your local computer. After you have the repo local just navigate to the root
47
-
directory, where this readme lives.
39
+
```console
40
+
pip install planet
41
+
```
48
42
49
-
Then you can install locally with pip:
43
+
To install from source, first clone this repository, then navigate to the root directory (where `setup.py` lives) and run:
50
44
51
45
```console
52
-
$ pip install .
46
+
pip install .
53
47
```
54
48
49
+
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.
50
+
51
+
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.
52
+
53
+
## Contributing and Development
54
+
55
+
To contribute or develop with this library, see [CONTRIBUTING.md](CONTRIBUTING.md).
56
+
55
57
## Documentation
56
58
57
59
Documentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/)
58
60
It should be considered 'in progress', with many updates to come. It can also
59
-
be built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be
61
+
be built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be
60
62
read from source in the [docs](/docs) directory.
61
63
62
64
## Authentication
63
65
64
-
Planet's APIs require an account for use. To get started you need to
65
-
[Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/).
66
-
67
-
## Development
68
-
69
-
To contribute or develop with this library, see
70
-
[CONTRIBUTING.md](CONTRIBUTING.md).
66
+
Planet's APIs require an account for use. To get started you need to
67
+
[Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/).
The available statuses are `created`, `queued`, `processing`, `failed`, and `success`. Note it’s quite useful
175
-
to use `jq` to help filter out results as well.
174
+
See the Subscriptions API documentation for the [official list of available statuses](https://developers.planet.com/docs/subscriptions/#subscription-status).
0 commit comments