Metadata-Version: 2.4
Name: pzserver
Version: 0.3.7
Author-email: LIneA <itteam@linea.org.br>
License-Expression: MIT
Project-URL: Source Code, https://github.com/linea-it/pzserver
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy<9,>=6
Requires-Dist: Deprecated<2,>=1
Requires-Dist: h5py<4,>=3.8
Requires-Dist: ipython<10,>=8
Requires-Dist: Jinja2<4,>=3.1.2
Requires-Dist: lsdb<1,>=0.6.4
Requires-Dist: matplotlib<4,>=3.9
Requires-Dist: numpy<3,>=1.24
Requires-Dist: pandas<3,>=2
Requires-Dist: pyarrow>=17
Requires-Dist: pydantic<3,>=2
Requires-Dist: requests<3,>=2
Requires-Dist: tables-io<2,>=1
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Requires-Dist: pytest-cov>=4; extra == "dev"
Requires-Dist: pre-commit>=3; extra == "dev"
Requires-Dist: ruff>=0.2; extra == "dev"
Requires-Dist: sphinx<8,>=7.0.0; extra == "dev"
Requires-Dist: sphinx_rtd_theme<2,>=1.2.0; extra == "dev"
Requires-Dist: sphinx-autoapi<4,>=3.0.0; extra == "dev"
Requires-Dist: sphinx-copybutton<1,>=0.5.0; extra == "dev"
Requires-Dist: pylint>=3; extra == "dev"
Requires-Dist: ipykernel>=6; extra == "dev"
Requires-Dist: nbconvert>=7; extra == "dev"
Requires-Dist: nbsphinx>=0.9; extra == "dev"
Requires-Dist: ipython>=8; extra == "dev"
Requires-Dist: jupyterlab>=4; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: ghp-import>=2; extra == "dev"
Dynamic: license-file

# 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 and services from the LSST [Photo-z Server](https://pz-server.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](https://github.com/linea-it/pzserver). 
 
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 (first time only).
 
    ```
    git clone git@github.com:linea-it/pzserver.git
    # or git clone https://github.com/linea-it/pzserver.git
    ```
</p>

2. Enter the repository and checkout to the development branch.

    ```
    cd pzserver
    git fetch origin
    git checkout <development branch name>
    git pull
    ```
</p>
    
3. Create a new Conda environment free from `pzserver`  old version installation. Delete any existing one with the same same, if necessary. 

    ```
    conda remove --name pzserver --all
    conda create -n pzserver python=3.12
    conda activate pzserver
    conda install pip
    python -m pip install -e '.[dev]'
    python -m ipykernel install --user --name pzserver --display-name "Python (pzserver)"
    ```
</p>

4. Open Python prompt or notebook and import the library:

    ```
    from pzserver import PzServer
    token = "****"  # your toker 
    pz = PzServer(token)                                   
    ```  

--- 
