projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 1d09f67e TL |
1 | .. Licensed to the Apache Software Foundation (ASF) under one |
| 2 | .. or more contributor license agreements. See the NOTICE file | |
| 3 | .. distributed with this work for additional information | |
| 4 | .. regarding copyright ownership. The ASF licenses this file | |
| 5 | .. to you under the Apache License, Version 2.0 (the | |
| 6 | .. "License"); you may not use this file except in compliance | |
| 7 | .. with the License. You may obtain a copy of the License at | |
| 8 | ||
| 9 | .. http://www.apache.org/licenses/LICENSE-2.0 | |
| 10 | ||
| 11 | .. Unless required by applicable law or agreed to in writing, | |
| 12 | .. software distributed under the License is distributed on an | |
| 13 | .. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| 14 | .. KIND, either express or implied. See the License for the | |
| 15 | .. specific language governing permissions and limitations | |
| 16 | .. under the License. | |
| 17 | ||
| 18 | .. _archery: | |
| 19 | ||
| 20 | Daily Development using Archery | |
| 21 | =============================== | |
| 22 | ||
| 23 | To ease some of the daily development tasks, we developed a Python-written | |
| 24 | utility called Archery. | |
| 25 | ||
| 26 | Installation | |
| 27 | ------------ | |
| 28 | ||
| 29 | Archery requires Python 3.6 or later. It is recommended to install archery in | |
| 30 | *editable* mode with the ``-e`` flag to automatically update the installation | |
| 31 | when pulling the Arrow repository. After cloning the Arrow repository, from | |
| 32 | the top level directory install Archery by using the command | |
| 33 | ||
| 34 | .. code:: bash | |
| 35 | ||
| 36 | pip install -e dev/archery[all] | |
| 37 | ||
| 38 | Usage | |
| 39 | ----- | |
| 40 | ||
| 41 | You can inspect Archery usage by passing the ``--help`` flag: | |
| 42 | ||
| 43 | .. code:: bash | |
| 44 | ||
| 45 | $ archery --help | |
| 46 | Usage: archery [OPTIONS] COMMAND [ARGS]... | |
| 47 | ||
| 48 | Apache Arrow developer utilities. | |
| 49 | ||
| 50 | See sub-commands help with `archery <cmd> --help`. | |
| 51 | ||
| 52 | Options: | |
| 53 | --debug Increase logging with debugging output. | |
| 54 | --pdb Invoke pdb on uncaught exception. | |
| 55 | -q, --quiet Silence executed commands. | |
| 56 | --help Show this message and exit. | |
| 57 | ||
| 58 | Commands: | |
| 59 | benchmark Arrow benchmarking. | |
| 60 | build Initialize an Arrow C++ build | |
| 61 | crossbow Schedule packaging tasks or nightly builds on CI services. | |
| 62 | docker Interact with docker-compose based builds. | |
| 63 | integration Execute protocol and Flight integration tests | |
| 64 | linking Quick and dirty utilities for checking library linkage. | |
| 65 | lint Check Arrow source tree for errors | |
| 66 | numpydoc Lint python docstring with NumpyDoc | |
| 67 | release Release releated commands. | |
| 68 | trigger-bot | |
| 69 | ||
| 70 | Archery exposes independent subcommands, each of which provides dedicated | |
| 71 | help output, for example: | |
| 72 | ||
| 73 | .. code:: bash | |
| 74 | ||
| 75 | $ archery docker --help | |
| 76 | Usage: archery docker [OPTIONS] COMMAND [ARGS]... | |
| 77 | ||
| 78 | Interact with docker-compose based builds. | |
| 79 | ||
| 80 | Options: | |
| 81 | --src <arrow_src> Specify Arrow source directory. | |
| 82 | --help Show this message and exit. | |
| 83 | ||
| 84 | Commands: | |
| 85 | images List the available docker-compose images. | |
| 86 | push Push the generated docker-compose image. | |
| 87 | run Execute docker-compose builds. |