| <!-- |
| 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. |
| --> |
| |
| |
| Installing hamilton is easy! |
| |
| # Install |
| |
| Apache Hamilton is a lightweight framework with a variety of extensions/plugins. To get started, you'll need the following: |
| |
| - ``python >= 3.10`` |
| - ``pip`` |
| |
| For help with python/pip/managing virtual environments see the [python docs](https://docs.python.org/3/tutorial/venv.html/). |
| |
| ## Installing with pip |
| |
| Apache Hamilton is published on [pypi](https://pypi.org/project/apache-hamilton/) under ``apache-hamilton``. To install, run: |
| |
| `pip install apache-hamilton` |
| |
| To use the DAG visualization functionality, instead install with |
| |
| `pip install apache-hamilton[visualization]` |
| |
| *Note: for visualization you may additionally need to install graphviz externally -- see* |
| [graphviz](https://graphviz.org/download/) *for instructions on the correct way for your |
| operating system.* |
| |
| ## Installing with conda |
| |
| Apache Hamilton is also available on conda if you prefer: |
| |
| `conda install -c hamilton-opensource apache-hamilton` |
| |
| ## Installing from source |
| |
| |
| You can also download the code and run it from the source. |
| |
| ```bash |
| git clone https://github.com/apache/hamilton.git |
| cd hamilton |
| pip install -e . |
| ``` |