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

Introduce conda directory containing datafusion-dev.yaml conda enviro… #124

Merged
merged 2 commits into from
Jan 18, 2023
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: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,18 @@ assert result.column(0) == pyarrow.array([6.0])

## How to install (from pip)

### Pip
```bash
pip install datafusion
# or
python -m pip install datafusion
```

### Conda
```bash
conda install -c conda-forge datafusion
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Who will update the conda-forge metadata for new releases ?
I.e. would it be possible that a new version of a-d-python is released, e.g. 0.9, and conda still installs 0.8 ?
If Conda does not fetch this info from PyPi then I expect users to file issues here about this and the a-d-p developers won't be able to help.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be the responsibility of the community to update conda-forge at release time. Let me add the logic in the release scripts and document that in this PR.

For what its worth there is an repo at https://anaconda.org/conda-forge/datafusion and I am trying to find out who owns that now so the proper permissions can be established

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be the responsibility of the community to update conda-forge at release time. Let me add the logic in the release scripts and document that in this PR.

For what its worth there is an repo at https://anaconda.org/conda-forge/datafusion and I am trying to find out who owns that now so the proper permissions can be established

I now have permissions for this repo and can add other PMC members

```

You can verify the installation by running:

```python
Expand All @@ -163,11 +169,25 @@ You can verify the installation by running:
'0.6.0'
```


## How to develop

This assumes that you have rust and cargo installed. We use the workflow recommended by [pyo3](https://github.com/PyO3/pyo3) and [maturin](https://github.com/PyO3/maturin).

Bootstrap:
The Maturin tools used in this workflow can be installed either via Conda or Pip. Both approaches should offer the same experience. Multiple approaches are only offered to appease developer preference. Bootstrapping for both Conda and Pip are as follows.

Bootstrap (Conda):

```bash
# fetch this repo
git clone [email protected]:apache/arrow-datafusion-python.git
# create the conda environment for dev
conda env create -f ./conda/environments/datafusion-dev.yaml -n datafusion-dev
# activate the conda environment
conda activate datafusion-dev
```

Bootstrap (Pip):

```bash
# fetch this repo
Expand Down
41 changes: 41 additions & 0 deletions conda/environments/datafusion-dev.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 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.

channels:
- conda-forge
dependencies:
- black
- flake8
- isort
- maturin
- mypy
- numpy
- pyarrow
- pytest
- toml
- importlib_metadata
- python>=3.7,<3.11
# Packages useful for building distributions and releasing
- mamba
- conda-build
- anaconda-client
# Packages for documentation building
- sphinx
- pydata-sphinx-theme==0.8.0
- myst-parser
- jinja2
name: datafusion-dev
20 changes: 20 additions & 0 deletions conda/recipes/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/bin/bash

# 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.

maturin build -r
50 changes: 50 additions & 0 deletions conda/recipes/meta.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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.

{% set version = environ.get('GIT_DESCRIBE_TAG', '0.0.0.dev').lstrip('v') + environ.get('VERSION_SUFFIX', '') %}
{% set minor_version = version.split('.')[0] + '.' + version.split('.')[1] %}

package:
name: datafusion
version: {{ version }}

source:
git_url: ../..

build:
noarch: python
number: 0

requirements:
host:
- {{ compiler('rust') }}
- python
- setuptools
- maturin
run:
- python

test:
imports:
- datafusion

about:
home: https://arrow.apache.org/datafusion
license: Apache-2.0
license_family: APACHE
license_file: LICENSE.txt
summary: Apache Arrow DataFusion Python Bindings
23 changes: 23 additions & 0 deletions dev/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,29 @@ This will create a file named `dist/datafusion-0.7.0.tar.gz`. Upload this to tes
python3 -m twine upload --repository testpypi dist/datafusion-0.7.0.tar.gz
```

### Publish Python Artifacts to Anaconda

Publishing artifacts to Anaconda is similar to PyPi. First, Download the source tarball created in the previous step and untar it.

```bash
# Assuming you have an existing conda environment named `datafusion-dev` if not see root README for instructions
conda activate datafusion-dev
conda build .
```

This will setup a virtual conda environment and build the artifacts inside of that virtual env. This step can take a few minutes as the entire build, host, and runtime environments are setup. Once complete a local filesystem path will be emitted for the location of the resulting package. Observe that path and copy to your clipboard.

Ex: `/home/conda/envs/datafusion/conda-bld/linux-64/datafusion-0.7.0.tar.bz2`

Now you are ready to publish this resulting package to anaconda.org. This can be accomplished in a few simple steps.

```bash
# First login to Anaconda with the datafusion credentials
anaconda login
# Upload the package
anaconda upload /home/conda/envs/datafusion/conda-bld/linux-64/datafusion-0.7.0.tar.bz2
```

### Send the Email

Send the email to start the vote.
Expand Down