Package Health Score

63 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

alkaline
39

Popularity

Small

GitHub Stars: 15.09K
Forks: 2.47K
Contributors: 120

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package yfbasic, we found that it has been starred 15,089 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Apr 10, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like yfbasic is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 167
Open PR: 31
Last Release: 4 years ago
Last Commit: 13 days ago

Further analysis of the maintenance status of yfbasic based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for yfbasic is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 120
Funding: Yes

A good and healthy external contribution signal for yfbasic project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.9,<4.0

Age: 4 years
Latest Release: 4 years ago
Dependencies: 2 Direct
Versions: 2
Maintainers: 0
Wheels: OS Independent

Readme

yfbasic

A thin python wrapper to retrieve price action data from the Yahoo! finance API.

There are similar packages available that does this, most notably yfinance. The purpose of this package is to present the raw data as typed objects to be consumed as desired.

Getting started

The interface is straight forward, just import and query.

import yfbasic

data = yfbasic.query("GME")

The supporting parameters are typed as well.

import yfbasic
from yfbasic import Range, Interval

data = yfbasic.query("GME", range=Range.r1mo, interval=Interval.i1h)

You can use query_threaded to parallelise the data retrieval.

import yfbasic

symbols = ("GME", "AMC", "TSLA")

data = yfbasic.query_threaded(symbols)

Working with the data

The data is modelled directly of the structure returned by the yahoo api. This makes it a bit more low level to work with, but the package makes no presumptions about how you intend to work with the data.

The best way to understand the data is to look at the data structure directly.

Error handling

If we look at the Chart data model it contains two optional parameters, result and error which means we need to do application side checking of the data. To satisfy type safety we need to at least verify the existence of results by checking data.chart.results . If we want insight into any API side errors we could verify and action upon data.chart.error

import yfbasic

data = yfbasic.query("GME")

# verifying the API produced results.
if data.chart.result:
    result = data.chart.result[0]
    quotes = result.indicators.quote[0]

    # getting price action data
    timestamps = result.timestamp
    open = quotes.open
    close = quotes.close
    high = quotes.high
    low = quotes.low
    volume = quotes.volume

yfbasic dependencies

pydantic requests

FAQs

What is yfbasic?

Thin python wrapper to retrieve and work with Yahoo! finance data. Visit Snyk Advisor to see a full health score report for yfbasic, including popularity, security, maintenance & community analysis.

Is yfbasic popular?

The python package yfbasic receives a total of 21 weekly downloads. As such, yfbasic popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is yfbasic well maintained?

We found indications that yfbasic is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is yfbasic safe to use?

The python package yfbasic was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 15 December-2024, at 08:22 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

yfbasic

Thin python wrapper to retrieve and work with Yahoo! finance data For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

yfbasic

Getting started

Working with the data

Error handling

yfbasic dependencies

FAQs

What is yfbasic?

Is yfbasic popular?

Is yfbasic well maintained?

Is yfbasic safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

yfbasic

Getting started

Working with the data

Error handling

yfbasic dependencies

FAQs

What is yfbasic?

Is yfbasic popular?

Is yfbasic well maintained?

Is yfbasic safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues