Skip to main content

tendrils api

Cosmic tendrils is a fully type annoted Python API wrapper for both FLOWS pipeline and project.

Currently, tendrils is reliant on the flows project webserver. However, the functionality is there for it to interface with any remote server providing an API with given URLS. all URLS can be modified in utils/urls.py to point to a different API, and tendrils can be used to interface with it.

Homepage: https://github.com/SNflows/tendrils
PYPI: https://pypi.org/project/tendrils/

installation

pip install tendrils

Requirements:

astropy, numpy, requests, tqdm
python >= 3.10

Before you begin [IMPORTANT!]

You will need to populate the included template config.ini with the right paths and flows API token. To do so, you can use the tools provided in tendrils.utils. There is:

  • a guided method that queries you in the command line for each field.
  • a function for copying from an already filled out (e.g., previous) config.ini file.
  • functions for setting each attribute separately (if you only need the API token for example)

using python shell (or ipython, or a script):

import tendrils

# Option 1
tendrils.utils.create_config()  # will also ask for location of where to store flows photometry.

# Option 2
tendrils.utils.copy_from_other_config('<path_to_other_config>')

# Option 3
# can also be called without any arguments to query for manually inputting the token.
tendrils.utils.set_api_token(token = 'my_long_token')  

After doing any of the above, your config.ini will have your API token, and all API calls will now use that token.

Dev

After cloning from the github repo, use the provided pyproject.toml file. Install using flit (pip install flit): flit install --symlink to install in EDITABLE mode. A legacy setup.py is also provided for installing with pip install -e . from the root directory. Important, do not upload you config.ini! Make sure all values are None as in the template from Pypi. We welcome all PRs.

Metadata

Release files for tendrils 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tendrils 0.3.2
File Size Uploaded Provenance Actions
tendrils-0.3.2.tar.gz 31.7 kB Without provenance Details for tendrils-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tendrils 0.3.2
File Interpreter ABI Platform Actions
tendrils-0.3.2-py3-none-any.whl Python 3 none any Details for tendrils-0.3.2-py3-none-any.whl

Total release size: 67.4 kB

Release files / tendrils-0.3.2.tar.gz

Download URL tendrils-0.3.2.tar.gz
Size 31.7 kB
Tags Source
SHA-256 checksum
How to use checksums
41075221cfbe924b43ef45f7916097b445016fbcbd0f59ec617773f5bc5f04d2
BLAKE2b-256 checksum
How to use checksums
7ae88923af3720be6c384ef92c80d6e9ff4acec037f5df8cf7c3fbb52176d079
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.27.1

Release files / tendrils-0.3.2-py3-none-any.whl

Download URL tendrils-0.3.2-py3-none-any.whl
Size 35.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62bdbc9957e6a4920dde8a5128e03298484b5b7e2f3541503271fa27a64c2c56
BLAKE2b-256 checksum
How to use checksums
dcb23f50b567d9db6da08cd52fe4934ea681f09c492e236753cd078fa0e4c39c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.27.1

Security for tendrils 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page