From c61fe3ceb608db8cea4e31668145879401982fca Mon Sep 17 00:00:00 2001 From: Johan Bregeon Date: Thu, 2 Feb 2023 11:34:50 +0100 Subject: [PATCH 1/3] conda environment yml file --- environment.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 environment.yml diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..32aad2b --- /dev/null +++ b/environment.yml @@ -0,0 +1,18 @@ +name: fink-client +channels: + - defaults + - conda-forge +dependencies: + - python>=3.9 + - coverage>=4.2 + - coveralls + - codecov + - python-confluent-kafka=1.9.2 + - fastavro=1.6.0 + - astropy + - numpy + - pyarrow>=10.0.1 + - pandas + - pyyaml + - tabulate + - matplotlib From d30e62f6191b51fe804ea21f207750a95e620a32 Mon Sep 17 00:00:00 2001 From: Johan Bregeon Date: Thu, 2 Feb 2023 11:49:23 +0100 Subject: [PATCH 2/3] update readme to include conda environment --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7759321..e89e6f3 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,26 @@ ## Installation -`fink_client` requires a version of Python 3.9+. To install it, just run +`fink_client` requires a version of Python 3.9+. + +### install with pip ```bash pip install fink-client --upgrade ``` +### install within a conda environment + +```bash +git clone https://github.com/astrolabsoftware/fink-client.git +cd fink-client +conda env create -f environment.yml +# install the latest release +pip install fink-client +# install for development +pip install -e . +``` + Learn how to connect and use it by checking the [documentation](docs/). ## Registration From de24a0449dfba50afad0d1c721606ddd60d1b79f Mon Sep 17 00:00:00 2001 From: Johan Bregeon Date: Thu, 2 Feb 2023 16:00:41 +0100 Subject: [PATCH 3/3] use python-confluent-kafka>=1.9.2 for py311 support --- environment.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/environment.yml b/environment.yml index 32aad2b..4d75fb1 100644 --- a/environment.yml +++ b/environment.yml @@ -7,7 +7,7 @@ dependencies: - coverage>=4.2 - coveralls - codecov - - python-confluent-kafka=1.9.2 + - python-confluent-kafka>=1.9.2 - fastavro=1.6.0 - astropy - numpy @@ -16,3 +16,4 @@ dependencies: - pyyaml - tabulate - matplotlib +