Package Health Score

66 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Popularity

Limited

GitHub Stars: 9
Forks: 22
Contributors: 20

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

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

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like prommis 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: 5
Open PR: 11
Last Release: 27 days ago
Last Commit: 11 days ago

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

We found that prommis 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: 20
Funding: No

With more than 10 contributors for the prommis 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 prommis 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.10.*, ==3.11.*, ==3.9.*

Age: 12 months
Latest Release: 27 days ago
Dependencies: 0 Direct
Versions: 8
Maintainers: 2
Wheels: OS Independent

Readme

prommis

Process Optimization and Modeling for Minerals Sustainability

Getting started (for PrOMMiS contributors)

Unless otherwise noted, these commands assume that the working directory is the root of the local clone of this repository (i.e. the directory containing this README file).

Installation

conda create --name prommis-dev --yes python=3.11
conda activate prommis-dev
git clone https://github.com/prommis/prommis && cd prommis
pip install -r requirements-dev.txt

Before committing

Before running any of these commands, ensure the prommis-dev Conda environment has been activated:

conda activate prommis-dev

Sort import statements

isort src/prommis

Formatting code

black .

Running linter (Pylint)

pylint prommis

Running spell checker (Typos)

typos

Note: if the typos executable is not found, it can be installed by running conda install --yes -c conda-forge typos after activating the prommis-dev Conda environment.

Running tests

pytest                          # run the complete test suite
pytest -k test_my_flowsheet.py  # run only test defined in the file named test_my_flowsheet.py

Building documentation

From the docs/ subdirectory:

jupyter-book build .

Testing (executing) notebooks

From the docs/ subdirectory:

pytest --nbmake -m "solution" .

FAQs

What is prommis?

. Visit Snyk Advisor to see a full health score report for prommis, including popularity, security, maintenance & community analysis.

Is prommis popular?

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

Is prommis well maintained?

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

Is prommis safe to use?

While scanning the latest version of prommis, 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 22 November-2024, at 18:54 (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

prommis

null 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

prommis

Getting started (for PrOMMiS contributors)

Installation

Before committing

Sort import statements

Formatting code

Running linter (Pylint)

Running spell checker (Typos)

Running tests

Building documentation

Testing (executing) notebooks

FAQs

What is prommis?

Is prommis popular?

Is prommis well maintained?

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

prommis

Getting started (for PrOMMiS contributors)

Installation

Before committing

Sort import statements

Formatting code

Running linter (Pylint)

Running spell checker (Typos)

Running tests

Building documentation

Testing (executing) notebooks

FAQs

What is prommis?

Is prommis popular?

Is prommis well maintained?

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