Package Health Score

52 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Popularity

Limited

GitHub Stars: 164
Forks: 34
Contributors: 20

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Dec 11, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

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

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like haxor 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: 5
Open PR: 2
Last Release: 12 months ago
Last Commit: 10 months ago

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

We found that haxor demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

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

With more than 10 contributors for the haxor repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like haxor is missing a Code of Conduct.

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.6.*

Age: 10 years
Latest Release: 12 months ago
Dependencies: 2 Direct / 6 Total
Versions: 16
Maintainers: 1
Wheels: OS Independent

Readme

haxor

build license

Unofficial Python wrapper for official Hacker News API.

Installation

pip install haxor

Usage

Import and initialization:

from hackernews import HackerNews
hn = HackerNews()

Items

Stories, comments, jobs, Ask HNs and even polls are just items with unique item id.

To query item information by id:

item = hn.get_item(8863)
# &gt;&gt;&gt; item.title
# 'My YC app: Dropbox - Throw away your USB drive'
# &gt;&gt;&gt; item.item_type
# 'story'
# &gt;&gt;&gt; item.kids
# [ 8952, 9224, 8917, ...]

Since most results are returned as integer IDs (like item.kids above), these results require further iteration. Instead of doing this yourself, use the expand flag to get object-oriented, detailed item info by id:

item = hn.get_item(8863, expand=True)
# &gt;&gt;&gt; item.kids
# [, , ...]
# &gt;&gt;&gt; item.by
#

To query a list of Item IDs:

items = hn.get_items_by_ids([8863, 37236, 2345])
# &gt;&gt;&gt; items
# [, , ]

Use the item_type filter to specifically select 'story', 'comment', 'job', or 'poll' items:

items = hn.get_items_by_ids([8863, 37236, 2345], item_type='story')
# &gt;&gt;&gt; items
# [, ]

Stories

The HN API allows for real-time querying for New, Top, Best, Ask HN, Show HN, and Jobs stories.

As an example, to get Item objects of current top stories:

top_stories = hn.top_stories()
# &gt;&gt;&gt; top_stories
# [, ...]

Useful Item Queries

To get current largest Item id (most recent story, comment, job, or poll):

max_item = hn.get_max_item()
# &gt;&gt;&gt; max_item
# 16925673

Once again, use the expand flag to get an object-oriented, detailed Item representation:

max_item = hn.get_max_item(expand=True)
# &gt;&gt;&gt; max_item
#

To get the x most recent Items:

last_ten = hn.get_last(10)
# &gt;&gt;&gt; last_ten
# [, ...]

Users

HN users are also queryable.

To query users by user_id (i.e. username on Hacker News):

user = hn.get_user('pg')
# &gt;&gt;&gt; user.user_id
# 'pg'
# &gt;&gt;&gt; user.karma
# 155040

Use the expand flag to get an object-oriented, detailed Item representation for User attributes:

user = hn.get_user('dhouston', expand=True)
# &gt;&gt;&gt; user.stories
# [, ...]
# &gt;&gt;&gt; user.comments
# [, , ...]
# &gt;&gt;&gt; user.jobs
# [, ...]

To query a list of users:

users = hn.get_users_by_ids(['pg','dhouston'])
# &gt;&gt;&gt; users
# [, ]

Examples

Get top 10 stories:

hn.top_stories(limit=10)

# [, , ...]

Find all the 'jobs' post from Top Stories:

stories = hn.top_stories()
for story in stories:
    if story.item_type == 'job':
        print(story)

# 
# ...
# ...

Find Python jobs from monthly who is hiring thread:

# Who is hiring - April 2018
# https://news.ycombinator.com/item?id=16735011

who_is_hiring = hn.get_item(16735011, expand=True)

for comment in who_is_hiring.kids:
    if 'python' in comment.text.lower():
        print(comment)

# 
# 
# ...
# ...

API Reference

Class: `HackerNews`

Parameters:

Name	Type	Required	Description	Default
`version`	string	No	specifies Hacker News API version	`v0`

`get_item`

Description: Returns Item object

Parameters:

Name	Type	Required	Description	Default
`item_id`	string/int	Yes	unique item id of Hacker News story, comment etc	None
`expand`	bool	No	flag to indicate whether to transform all IDs into objects	False

`get_items_by_ids`

Description: Returns list of Item objects

Parameters:

Name	Type	Required	Description	Default
`item_ids`	list of string/int	Yes	unique item ids of Hacker News stories, comments etc	None
`item_type`	string	No	item type to filter results with	None

`get_user`

Description: Returns User object

Parameters:

Name	Type	Required	Description	Default
`user_id`	string	Yes	unique user id of a Hacker News user	None
`expand`	bool	No	flag to indicate whether to transform all IDs into objects	False

`get_users_by_ids`

Description: Returns list of User objects

Parameters:

Name	Type	Required	Description	Default
`user_ids`	list of string/int	Yes	unique user ids of Hacker News users	None

`top_stories`

Description: Returns list of Item objects of current top stories

Parameters:

Name	Type	Required	Description	Default
`raw`	bool	No	indicate whether to represent all objects in raw json	False
`limit`	int	No	specifies the number of stories to be returned	None

`new_stories`

Description: Returns list of Item objects of current new stories

Parameters:

Name	Type	Required	Description	Default
`raw`	bool	No	indicate whether to represent all objects in raw json	False
`limit`	int	No	specifies the number of stories to be returned	None

`ask_stories`

Description: Returns list of Item objects of latest Ask HN stories

Parameters:

Name	Type	Required	Description	Default
`raw`	bool	No	indicate whether to represent all objects in raw json	False
`limit`	int	No	specifies the number of stories to be returned	None

`show_stories`

Description: Returns list of Item objects of latest Show HN stories

Parameters:

Name	Type	Required	Description	Default
`raw`	bool	No	indicate whether to represent all objects in raw json	False
`limit`	int	No	specifies the number of stories to be returned	None

`job_stories`

Description: Returns list of Item objects of latest Job stories

Parameters:

Name	Type	Required	Description	Default
`raw`	bool	No	indicate whether to represent all objects in raw json	False
`limit`	int	No	specifies the number of stories to be returned	None

`updates`

Description: Returns list of Item and User objects that have been changed/updated recently.

Parameters: N/A

`get_max_item`

Description: Returns current largest item id or current largest Item object

Parameters:

Name	Type	Required	Description	Default
`expand`	bool	No	flag to indicate whether to transform ID into object	False

`get_all`

Description: Returns all Item objects from HN

Parameters: N/A

`get_last`

Description: Returns list of num most recent Item objects

Parameters:

Name	Type	Required	Description	Default
`num`	int	No	numbr of most recent records to pull from HN	10

Class: `Item`

From Official HackerNews Item:

Property	Description
item_id	The item’s unique id.
deleted	`true` if the item is deleted.
item_type	The type of item. One of “job”, “story”, “comment”, “poll”, or “pollopt”.
by	The username of the item’s author.
submission_time	Creation date of the item, in Python `datetime`.
text	The comment, Ask HN, or poll text. HTML.
dead	`true` if the item is dead.
parent	The item’s parent. For comments, either another comment or the relevant story. For pollopts, the relevant poll.
poll	The ids of poll's.
kids	The ids of the item’s comments, in ranked display order.
url	The URL of the story.
score	The story’s score, or the votes for a pollopt.
title	The title of the story or poll.
parts	A list of related pollopts, in display order.
descendants	In the case of stories or polls, the total comment count.
raw	original JSON response.

Class: `User`

From Official HackerNews User:

Property	Description
user_id	The user’s unique username. Case-sensitive.
delay	Delay in minutes between a comment’s creation and its visibility to other users.
created	Creation date of the user, in Python `datetime`.
karma	The user’s karma.
about	The user’s optional self-description. HTML.
submitted	List of the user’s stories, polls and comments.
raw	original JSON response.

Additional properties when expand is used

Property	Description
stories	The user’s submitted stories.
comments	The user's submitted comments.
jobs	The user's submitted jobs.
polls	The user's submitted polls.
pollopts	The user's submitted poll options.

Development

For local development do pip installation of requirements-dev.txt:

pip install -r requirements-dev.txt

Testing

Run the test suite by running:

echo "0.0.0-dev" &gt; version.txt
python setup.py develop
pytest tests

LICENSE

The mighty MIT license. Please check LICENSE for more details.

haxor dependencies

aiohttp requests

FAQs

What is haxor?

Unofficial Python wrapper for Hacker News API. Visit Snyk Advisor to see a full health score report for haxor, including popularity, security, maintenance & community analysis.

Is haxor popular?

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

Is haxor well maintained?

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

Is haxor safe to use?

While scanning the latest version of haxor, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 25 November-2024, at 16:49 (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

Package Health Score

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

haxor

Installation

Usage

Import and initialization:

Items

Stories

Useful Item Queries

Users

Examples

API Reference

Class: HackerNews

get_item

get_items_by_ids

get_user

get_users_by_ids

top_stories

new_stories

ask_stories

show_stories

job_stories

updates

get_max_item

get_all

get_last

Class: Item

Class: User

Development

Testing

LICENSE

haxor dependencies

FAQs

What is haxor?

Is haxor popular?

Is haxor well maintained?

Is haxor 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

Class: `HackerNews`

`get_item`

`get_items_by_ids`

`get_user`

`get_users_by_ids`

`top_stories`

`new_stories`

`ask_stories`

`show_stories`

`job_stories`

`updates`

`get_max_item`

`get_all`

`get_last`

Class: `Item`

Class: `User`