pzserver 0.2.7__tar.gz → 0.2.8__tar.gz

{pzserver-0.2.7 → pzserver-0.2.8}/.devcontainer/devcontainer.json

@@ -7,10 +7,10 @@
 	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
 	"features": {
 		"ghcr.io/devcontainers/features/common-utils:2": {},
-		"ghcr.io/devcontainers/features/github-cli:1": {},
-		"ghcr.io/devcontainers-contrib/features/black:2": {},
+		// "ghcr.io/devcontainers/features/github-cli:1": {},
+		// "ghcr.io/devcontainers-contrib/features/black:2": {},
 		"ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {},
-		"ghcr.io/dhoeric/features/act:1": {},
+		// "ghcr.io/dhoeric/features/act:1": {},
 		"ghcr.io/stuartleeks/dev-container-features/shell-history:0": {}
 	},
 	// Features to add to the dev container. More info: https://containers.dev/features.

{pzserver-0.2.7 → pzserver-0.2.8}/.devcontainer/docker-compose.yml

@@ -9,6 +9,9 @@ services:
     volumes:
       - ../..:/workspaces:cached
 
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
     # Overrides default command so things don't shut down after the process ends.
     command: sleep infinity
     # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.

{pzserver-0.2.7 → pzserver-0.2.8}/.github/workflows/build-documentation.yml

@@ -30,7 +30,7 @@ jobs:
         sudo apt-get install pandoc
     - name: Build docs
       run: |
-        sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html -D exclude_patterns="notebooks/*/*.ipynb"
+        sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html -D exclude_patterns="notebooks/**.ipynb"
     - name: Run ghp-import
       run: | 
         ghp-import -n -p -f -x docs/ docs/build/html

{pzserver-0.2.7 → pzserver-0.2.8}/.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
         description: Clear output from Jupyter notebooks.
         files: \.ipynb$
         exclude: ^docs/notebooks/intro_notebook.ipynb$
-        stages: [commit]
+        stages: [pre-commit]
         language: system
         entry: jupyter nbconvert --clear-output
 
@@ -123,5 +123,5 @@ repos:
             "-d", # Flag for cached environment and doctrees
             "./docs/build/doctrees", # Directory
             "-D", # Flag to override settings in conf.py
-            "exclude_patterns=notebooks/*/*.ipynb", # Exclude our notebooks from pre-commit
+            "exclude_patterns=notebooks/**.ipynb", # Exclude our notebooks from pre-commit
           ]

{pzserver-0.2.7 → pzserver-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pzserver
-Version: 0.2.7
+Version: 0.2.8
 Author-email: LIneA <itteam@linea.org.br>
 License: MIT License
         
@@ -64,6 +64,7 @@ Requires-Dist: ipython; extra == "dev"
 Requires-Dist: jupyterlab; extra == "dev"
 Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: ghp-import; extra == "dev"
+Dynamic: license-file
 
 # Pz Server Library
 
@@ -72,10 +73,53 @@ Requires-Dist: ghp-import; extra == "dev"
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/linea-it/pzserver/build-documentation.yml?label=docs)
 ![GitHub](https://img.shields.io/github/license/linea-it/pzserver)
 
-A Python library to access data from the [Photo-z Server](https://pz-server-dev.linea.org.br/). 
+A Python library to access data from the LSST [Photo-z Server](https://pz-server-dev.linea.org.br/). 
 
-The Photo-z Server is an online service based on software developed and delivered as part of the in-kind contribution program BRA-LIN, from LIneA to the Rubin Observatory's LSST. The Photo-z Server is open source, and the code is
-available on the GitHub repository [linea-it/pzserver_app](https://github.com/linea-it/pzserver_app). 
+The Photo-z (PZ) Server is an online service based on software developed and delivered as part of the in-kind contribution program BRA-LIN, from LIneA to the Legacy Survey of Space and Time (LSST) caried out by the [Rubin Observatory](https://rubinobservatory.org/). The PZ Server is an open source project. The source code is available on the GitHub repository [linea-it/pzserver_app](https://github.com/linea-it/pzserver_app). 
  
 An overview of this and other contributions is available [here](https://linea-it.github.io/pz-lsst-inkind-doc/).  
 The API documentation is available [here](https://linea-it.github.io/pzserver). 
+
+
+This repo uses the [LINCC's Python Project Template](https://github.com/lincc-frameworks/python-project-template), described in the article: [A Python Project Template for Healthy Scientific Software](https://iopscience.iop.org/article/10.3847/2515-5172/ad4da1).
+
+ 
+--- 
+
+## Instructions for developers: 
+
+### How to validate a PR 
+
+Step-by-step procedure to test a new feature or bug fix from a particular branch not using a previously installed version (not the only way, just a suggestion): 
+
+1. Clone the repository and checkout to the development branch.
+    ```
+    git clone git@github.com:linea-it/pzserver.git
+    cd pzserver 
+    git checkout <development branch name>
+    ```
+    or just
+   ```
+   cd pzserver 
+   git pull
+   git checkout <development branch name>
+   ```
+   if you already have it.
+    
+3. Create a new Conda environment free from `pzserver`  old version installation
+    ```
+    conda create -n pzserver-dev
+    conda activate pzserver-dev
+    conda install pip
+    pip install -e '.'
+    ```
+
+4. Open Python prompt or notebook and import the library:
+   ```
+   from pzserver import PzServer
+   token = "****"  # your toker 
+   host = "pz-dev" # or "localhost" if testing pipeline back-end locally
+   pz = PzServer(token, host)                                   
+   ```  
+
+--- 

pzserver-0.2.8/README.md

@@ -0,0 +1,57 @@
+# Pz Server Library
+
+![PyPI](https://img.shields.io/pypi/v/pzserver?label=PyPI)
+![PyPI - Status](https://img.shields.io/pypi/status/pzserver)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/linea-it/pzserver/build-documentation.yml?label=docs)
+![GitHub](https://img.shields.io/github/license/linea-it/pzserver)
+
+A Python library to access data from the LSST [Photo-z Server](https://pz-server-dev.linea.org.br/). 
+
+The Photo-z (PZ) Server is an online service based on software developed and delivered as part of the in-kind contribution program BRA-LIN, from LIneA to the Legacy Survey of Space and Time (LSST) caried out by the [Rubin Observatory](https://rubinobservatory.org/). The PZ Server is an open source project. The source code is available on the GitHub repository [linea-it/pzserver_app](https://github.com/linea-it/pzserver_app). 
+ 
+An overview of this and other contributions is available [here](https://linea-it.github.io/pz-lsst-inkind-doc/).  
+The API documentation is available [here](https://linea-it.github.io/pzserver). 
+
+
+This repo uses the [LINCC's Python Project Template](https://github.com/lincc-frameworks/python-project-template), described in the article: [A Python Project Template for Healthy Scientific Software](https://iopscience.iop.org/article/10.3847/2515-5172/ad4da1).
+
+ 
+--- 
+
+## Instructions for developers: 
+
+### How to validate a PR 
+
+Step-by-step procedure to test a new feature or bug fix from a particular branch not using a previously installed version (not the only way, just a suggestion): 
+
+1. Clone the repository and checkout to the development branch.
+    ```
+    git clone git@github.com:linea-it/pzserver.git
+    cd pzserver 
+    git checkout <development branch name>
+    ```
+    or just
+   ```
+   cd pzserver 
+   git pull
+   git checkout <development branch name>
+   ```
+   if you already have it.
+    
+3. Create a new Conda environment free from `pzserver`  old version installation
+    ```
+    conda create -n pzserver-dev
+    conda activate pzserver-dev
+    conda install pip
+    pip install -e '.'
+    ```
+
+4. Open Python prompt or notebook and import the library:
+   ```
+   from pzserver import PzServer
+   token = "****"  # your toker 
+   host = "pz-dev" # or "localhost" if testing pipeline back-end locally
+   pz = PzServer(token, host)                                   
+   ```  
+
+--- 

{pzserver-0.2.7 → pzserver-0.2.8}/docs/index.rst

@@ -15,7 +15,6 @@ The Photo-z Server Library is a Python package to support the Photo-z Server use
    Home page <self>
    Install <installation>
    API Reference <autoapi/index>
-   Notebooks <nbs>
 
 
 Indices and tables

pzserver-0.2.8/docs/notebooks/images/Untitled.ipynb

@@ -0,0 +1,108 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "c0e65a7b-2141-414a-adc1-a9f3200f7698",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-01-03T15:46:42.011769Z",
+     "iopub.status.busy": "2025-01-03T15:46:42.011275Z",
+     "iopub.status.idle": "2025-01-03T15:46:42.064965Z",
+     "shell.execute_reply": "2025-01-03T15:46:42.064110Z",
+     "shell.execute_reply.started": "2025-01-03T15:46:42.011740Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from lsst.rsp import get_tap_service, retrieve_query\n",
+    "service = get_tap_service('tap')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "9838e72e-acd1-4176-b8d9-54b8bd2882d7",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-01-03T15:46:44.023789Z",
+     "iopub.status.busy": "2025-01-03T15:46:44.022946Z",
+     "iopub.status.idle": "2025-01-03T15:46:44.027068Z",
+     "shell.execute_reply": "2025-01-03T15:46:44.026384Z",
+     "shell.execute_reply.started": "2025-01-03T15:46:44.023750Z"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "url='https://data.lsst.cloud/api/tap/async/dq8t822tn89e0lpd'"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "3f822d7a-c49e-4d09-958e-6c9fa3764e30",
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2025-01-03T15:49:16.639677Z",
+     "iopub.status.busy": "2025-01-03T15:49:16.639235Z",
+     "iopub.status.idle": "2025-01-03T15:49:16.760872Z",
+     "shell.execute_reply": "2025-01-03T15:49:16.760339Z",
+     "shell.execute_reply.started": "2025-01-03T15:49:16.639646Z"
+    }
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "<pyvo.dal.tap.AsyncTAPJob at 0x7a0708f8a110>"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "retrieved_job = retrieve_query(url)\n",
+    "retrieved_job"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "44207b24-0e1f-4305-92be-3358cf6eeba8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "retrieved_job.phase"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "id": "e3eddeab-0eff-4d49-8b0a-a09a874de5ed",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "LSST",
+   "language": "python",
+   "name": "lsst"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}