Package Health Score

78 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Popularity

Recognized

GitHub Stars: 88
Forks: 21
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package aleph-alpha-client, we found that it has been starred 88 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 18, 2024
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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like aleph-alpha-client 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

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 4 days ago
Last Commit: 18 days ago

Further analysis of the maintenance status of aleph-alpha-client based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that aleph-alpha-client demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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

Sustainable

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

With more than 10 contributors for the aleph-alpha-client 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 aleph-alpha-client 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.13,>=3.8

Age: 3 years
Latest Release: 4 days ago
Dependencies: 0 Direct
Versions: 76
Maintainers: 1
Wheels: OS Independent

Readme

Aleph Alpha Client

Python client for the Aleph Alpha API.

Usage

Synchronous Client

import os
from aleph_alpha_client import Client, CompletionRequest, Prompt

client = Client(token=os.getenv("AA_TOKEN"))
request = CompletionRequest(
    prompt=Prompt.from_text("Provide a short description of AI:"),
    maximum_tokens=64,
)
response = client.complete(request, model="luminous-extended")

print(response.completions[0].completion)

Asynchronous Client

import os
from aleph_alpha_client import AsyncClient, CompletionRequest, Prompt

# Can enter context manager within an async function
async with AsyncClient(token=os.environ["AA_TOKEN"]) as client:
    request = CompletionRequest(
        prompt=Prompt.from_text("Provide a short description of AI:"),
        maximum_tokens=64,
    )
    response = client.complete_with_streaming(request, model="luminous-base")

    async for stream_item in response:
        print(stream_item)

Interactive Examples

This table contains interactive code examples, further exercises can be found in the examples repository.

Template	Description	Internal Link
1	Calling the API	Template 1
2	Simple completion	Template 2
3	Simple search	Template 3
4	Symmetric and Asymmetric Search	Template 4
5	Hidden Embeddings	Template 5
6	Task-specific Endpoints	Template 6

Installation

The latest stable version is deployed to PyPi so you can install this package via pip.

pip install aleph-alpha-client

Get started using the client by first creating an account. Afterwards head over to your profile to create an API token. Read more about how you can manage your API tokens here.

Development

For local development, start by creating a Python virtual environment as follows:

python3 -m venv venv
. ./venv/bin/activate

Next, install the test and dev dependencies:

poetry install --extras "dev"

Now you should be able to ...

run all the tests using pytest or, pytest -k to run a specific test
typecheck the code and tests using mypy aleph_alpha_client resp. mypy tests
format the code using black .

FAQs

What is aleph-alpha-client?

python client to interact with Aleph Alpha api endpoints. Visit Snyk Advisor to see a full health score report for aleph-alpha-client, including popularity, security, maintenance & community analysis.

Is aleph-alpha-client popular?

The python package aleph-alpha-client receives a total of 18,116 weekly downloads. As such, aleph-alpha-client popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is aleph-alpha-client well maintained?

We found that aleph-alpha-client demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is aleph-alpha-client safe to use?

The python package aleph-alpha-client 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 21 November-2024, at 22:00 (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

aleph-alpha-client

python client to interact with Aleph Alpha api endpoints For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

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

Aleph Alpha Client

Usage

Synchronous Client

Asynchronous Client

Interactive Examples

Installation

Development

Links

FAQs

What is aleph-alpha-client?

Is aleph-alpha-client popular?

Is aleph-alpha-client well maintained?

Is aleph-alpha-client 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

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

Aleph Alpha Client

Usage

Synchronous Client

Asynchronous Client

Interactive Examples

Installation

Development

Links

FAQs

What is aleph-alpha-client?

Is aleph-alpha-client popular?

Is aleph-alpha-client well maintained?

Is aleph-alpha-client 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