Package Health Score

75 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

GitHub Stars: 1.64K
Forks: 667
Contributors: 180

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Apr 23, 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
1
M
0
L

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

License

LGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

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

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

We found that ifctester 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

Active

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

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

We found a way for you to contribute to the project! Looks like ifctester 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.*

Age: 12 months
Latest Release: 12 days ago
Dependencies: 4 Direct / 6 Total
Versions: 19
Maintainers: 2
Wheels: OS Independent

Readme

ifctester

With IfcTester, you can author and read Information Delivery Specification - IDS - files and validate your IFC models against IDS to see if your model is compliant. After the audit, you can generate reports in console, as a web page, JSON or BCF file. It works from the command line, as a web app, or as a library.

How to use it

Command line use

.. code-block:: bash

# run console reporter
python -m ifctester example.ids example.ifc
python -m ifctester example.ids example.ifc -r Html -o report.html

Available flags:

-r / --reporter: The reporting method to view audit results. Availabe reporters: Console, Txt, Json, Html, Ods, Bcf
--no-color: Disable colour output (supported by Console reporting).
--excel-safe: Make sure exported ODS is safely exported for Excel.
-o / --output: Output file (supported for all types of reporting except Console).

Code example

import ifcopenshell
from ifctester import ids, reporter


# create new IDS
my_ids = ids.Ids(title="My IDS")

# add specification to it
my_spec = ids.Specification(name="My first specification")
my_spec.applicability.append(ids.Entity(name="IFCWALL"))
property = ids.Property(
    baseName="IsExternal",
    value="TRUE", 
    propertySet="Pset_WallCommon", 
    dataType="IfcBoolean",
    uri="https://identifier.buildingsmart.org/uri/.../prop/LoadBearing", 
    instructions="Walls need to be load bearing.",
    cardinality="required")
my_spec.requirements.append(property)
my_ids.specifications.append(my_spec)

# Save such IDS to file
result = my_ids.to_xml("SampleIDS.xml")

# open  IFC file:
my_ifc = ifcopenshell.open("MyIfcModel.ifc")

# validate IFC model against IDS requirements:
my_ids.validate(my_ifc)

# show results:
reporter.Console(my_ids).report()

ifctester dependencies

ifcopenshell numpy python-dateutil xmlschema

FAQs

What is ifctester?

IFC model auditing tool with support for IDS. Visit Snyk Advisor to see a full health score report for ifctester, including popularity, security, maintenance & community analysis.

Is ifctester popular?

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

Is ifctester well maintained?

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

Is ifctester safe to use?

While scanning the latest version of ifctester, 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 3 May-2024, at 11:33 (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

ifctester

IFC model auditing tool with support for IDS 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

Non-Permissive License

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

ifctester

How to use it

Command line use

Code example

ifctester dependencies

FAQs

What is ifctester?

Is ifctester popular?

Is ifctester well maintained?

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

ifctester

How to use it

Command line use

Code example

ifctester dependencies

FAQs

What is ifctester?

Is ifctester popular?

Is ifctester well maintained?

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