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