Package Health Score

72 / 100

security
Security review needed
popularity
Recognized
maintenance
Healthy
community
Sustainable

Explore Similar Packages

union
36

Popularity

Recognized

GitHub Stars: 84
Forks: 106
Contributors: 50

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Apr 3, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
1
M
0
L
License Risk: 0
H
3
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 pycti is missing a security policy.

A security vulnerability was detected in an indirect dependency that is added to your project when the latest version of pycti is installed.

We highly advise you to review these security issues.

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

Fix it in your project with Snyk!

Maintenance

Healthy

Commit Frequency

Open Issues: 27
Open PR: 7
Last Release: 15 days ago
Last Commit: 11 days ago

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

We found that pycti 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: No
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the pycti 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 pycti 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.7

Age: 5 years
Latest Release: 15 days ago
Dependencies: 0 Direct
Versions: 227
Maintainers: 1
Wheels: OS Independent

Not sure how to use pycti?

To help you get started, we've collected the most common ways that pycti is being used within popular public projects.

OpenCTI-Platform / opencti / opencti-worker / src / worker.py View on Github

self.log_level = os.getenv('WORKER_LOG_LEVEL', 'info')
            self.opencti_url = os.getenv('OPENCTI_URL', 'http://localhost:4000')
            self.opencti_token = os.getenv('OPENCTI_TOKEN', 'ChangeMe')
            self.rabbitmq_hostname = os.getenv('RABBITMQ_HOSTNAME', 'localhost')
            self.rabbitmq_port = os.getenv('RABBITMQ_PORT', 5672)
            self.rabbitmq_port_management = os.getenv('RABBITMQ_PORT_MANAGEMENT', 15672)
            self.rabbitmq_management_ssl = os.getenv('RABBITMQ_MANAGEMENT_SSL', "false") == "true"
            self.rabbitmq_username = os.getenv('RABBITMQ_USERNAME', 'guest')
            self.rabbitmq_password = os.getenv('RABBITMQ_PASSWORD', 'guest')

        # Check configuration
        if len(self.opencti_token) == 0 or self.opencti_token == 'ChangeMe':
            raise ValueError('Token configuration must be the same as APP__ADMIN__TOKEN')

        # Check if openCTI is available
        self.api = OpenCTIApiClient(self.opencti_url, self.opencti_token)
        if not self.api.health_check():
            raise ValueError('OpenCTI API seems down')

        if self.type == 'import':
            self.DEFAULT_QUEUE_NAME = 'import-platform'
            self.DEFAULT_ROUTING_KEY = 'import.platform'
            self.CONNECTOR_QUEUE_PREFIX = 'import-connectors-'
        elif self.type == 'export':
            self.DEFAULT_QUEUE_NAME = 'export-platform'
            self.DEFAULT_ROUTING_KEY = 'export.platform'
            self.CONNECTOR_QUEUE_PREFIX = 'export-connectors-'

        # Configure logger
        numeric_level = getattr(logging, self.log_level.upper(), None)
        if not isinstance(numeric_level, int):
            raise ValueError('Invalid log level: ' + self.log_level)

View more ways to use pycti

OpenCTI client for Python

The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils. This client is also used by some OpenCTI components.

Install

To install the latest Python client library, please use pip:

$ pip3 install pycti

Local development

# Fork the current repository, then clone your fork
$ git clone https://github.com/YOUR-USERNAME/client-python
$ cd client-python
$ git remote add upstream https://github.com/OpenCTI-Platform/client-python.git
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ python3 -m venv .venv
$ source .venv/bin/activate
# Install the client-python and dependencies for the development and the documentation
$ python3 -m pip install -e .[dev,doc]
# Set up the git hook scripts
$ pre-commit install
# Create your feature/fix
# Create tests for your changes
$ pytest
# Push you feature/fix on Github
$ git add [file(s)]
$ git commit -m "[descriptive message]"
$ git push origin [branch-name]
# Open a pull request

Install the package locally

$ pip install -e .

Documentation

Client usage

To learn about how to use the OpenCTI Python client and read some examples and cases, refer to the client documentation.

API reference

To learn about the methods available for executing queries and retrieving their answers, refer to the client API Reference.

Tests

Install dependencies

$ pip install -r ./test-requirements.txt

pytest is used to launch the tests.

Launch tests

Prerequisite

Your OpenCTI API should be running. Your conftest.py should be configured with your API url, your token, and if applicable, your mTLS cert/key.

Launching

Unit tests

$ pytest ./tests/01-unit/

Integration testing

$ pytest ./tests/02-integration/

About

OpenCTI is a product designed and developed by the company Filigran.

FAQs

What is pycti?

Python API client for OpenCTI. Visit Snyk Advisor to see a full health score report for pycti, including popularity, security, maintenance & community analysis.

Is pycti popular?

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

Is pycti well maintained?

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

Is pycti safe to use?

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

Last updated on 16 April-2024, at 18: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