Package Health Score

79 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Active

Popularity

Recognized

GitHub Stars: 53
Forks: 52
Contributors: 30

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 27, 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

Yes

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

Sustainable

Commit Frequency

Open Issues: 36
Open PR: 5
Last Release: 4 months ago
Last Commit: 5 months ago

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

We found that sfctl demonstrates a positive version release cadence with at least one new version released in the past 12 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: Yes
Code of Conduct: Yes
Contributors: 30
Funding: No

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

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: <4,>3.8

Age: 7 years
Latest Release: 4 months ago
Dependencies: 8 Direct
Versions: 20
Maintainers: 1
Wheels: OS Independent

Not sure how to use sfctl?

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

microsoft / service-fabric-cli / src / sfctl / custom_cluster.py View on Github

def get_aad_token(endpoint, no_verify):
    #pylint: disable-msg=too-many-locals
    """Get AAD token"""

    auth = ClientCertAuthentication(None, None, no_verify)

    client = ServiceFabricClientAPIs(auth, base_url=endpoint)
    aad_metadata = client.get_aad_metadata()

    if aad_metadata.type != "aad":
        raise CLIError("Not AAD cluster")

    aad_resource = aad_metadata.metadata

    tenant_id = aad_resource.tenant
    authority_uri = aad_resource.login + '/' + tenant_id
    context = adal.AuthenticationContext(authority_uri,
                                         api_version=None)
    cluster_id = aad_resource.cluster
    client_id = aad_resource.client

View more ways to use sfctl

Service Fabric CLI

A command line interface for interacting with Azure Service Fabric clusters and their related entities.

Invocation

To get started, after installation run the following:

sfctl -h

Change Log

11.2.1

Updated versions of dependency libraries

11.2.0

Updated to use 8.2 Service fabric SDK
pinned version of requests to 2.27.0

11.1.0

Added get top/least loaded partitions command. It will be available in the Service fabric runtime 8.0 version.
Added move replica partition commands. Move primary and secondary replica commands will be available in the Service fabric runtime 6.5 version. Move instance command will be available in the Service fabric runtime 8.0 version. (#227)
Updating 'application upload' native imagestore application upload to parallelize uploads, greatly reducing overall upload time for applications with many smaller files. Also improving progress log shown by flag '--show-progress'. (#223)
Added add/remove node tags commands. They will be available in the Service fabric runtime 8.0 version. (#232)
Update Create and Update service with new parameters, TagsRequiredToPlace and TagsRequiredToRun (#232)
Update imports for Service fabric runtime version 8.0 (#235)

11.0.0

Update imports for Service fabric runtime version 7.2 (#225)

10.0.0

Update imports for Service fabric runtime version 7.1 (#218)

9.0.0

Added configuration overrides node commands. These commands will be available in the Service fabric runtime 7.0 version (#206)
Provide option to compress packages on application upload. By default, the newly generated compressed package is deleted after successful upload. (#191)
Update Create and Update service with new parameter, ServicePlacementTimeLimit (#200)
Update knack version (#207)

8.0.0

Update imports for Service fabric runtime version 6.5 (#195)

7.1.0

Increase default timeout of application upload to 300 seconds, and allow upload timeouts to be configurable. The new timeout will be an overall operation timeout for all uploads, rather than individual operation timeouts of 60 seconds as existed before. Improvements to help text (#131)
Improve help text on cluster select (#173)
Add events commands (sfctl events) to retrieve events through EventStore service if installed (#174)
Cluster select defaults to endpoint if none is provided (#178)
Change serializers, and change formatting of sfctl container invoke-api output (#179)
Update Knack version to 0.5.2 (#181)
Update sfmergeutility version to 0.1.6 (#183)
Improve error message (#185)

7.0.2

Pause telemetry collection. Update code for 7.0.2 release (#172)

7.0.1

Fix bug where an empty directory is generated in the current location. Update code for 7.0.1 release (#167)

7.0.0

Add upgrade-rollback command for compose deployment (#119)
Upgrade the knack package dependency to version 0.4.2 (#122)
Add a check to ensure sfctl version is compatible with the connected cluster version. This check is run periodically and on failures (#123)
Remove retry on failed commands, such as 500 status codes being returned. This allows the proper error message to propagate through (#125)
Add Mesh app, volume, service, and service-replica commands (#129)
Add Mesh network, gateway, code package, secret, and secretvalue commands (#141)
Allow any Python 3.7.x versions rather than only 3.7.0 (#142)
Add the command "sfctl mesh deployment create", which takes resource description yaml files as input and deploys the corresponding mesh resources (#146)
Fix missing option of "Error" health state in health reporting (#151)
Add telemetry. The following data is collected: Command name without parameters provided or their values, sfctl version, OS, python version, the success or failure of the command, and if the command failed, the error message returned. Upgrade knack package dependency to version 0.5.1 (#152)
Update to 6.4 Service Fabric runtime (#163)

6.0.1

Some typo fixes (#115)

6.0.0

Add application health policies parameter for config upgrade, which are available in Service Fabric runtime 6.3 (#92)
Add command "sfctl cluster show-connection". Command shows the currently connected cluster connection. Nothing is returned if no endpoint is set (#103)
Add command override "sfctl --version" to see the current sfctl version (#104)
Add parameter to set max results for query "sfctl node list" (#113)

5.0.0

Add commands to get and set chaos schedule (#70)
Add commands to get chaos and get events for chaos (#70)
Remove command to get chaos report. The functionality is replaced by command get chaos and the command get chaos events (#70)
Typo fix for service commands (#71)
Add missing help text (#71)
Fix bug in displaying property help text (#71)
Add scaling policy parameter to the command for service create and the command for service update (#76)
Add new group called container with commands: invoke-api (invoke raw container REST API) and logs (get container logs) (#82)
Add support for passing json values to arguments as .txt files. Input starting with '@' are considered paths (#84)
Update to 6.2 Service Fabric runtime (#97)
Rename and change value of application upgrade parameter application-name to application-id (#97)

4.0.0

Update to 6.1 Service Fabric runtime (#64)
Property command group added
Added support for external stores when calling application provision
Provision and unprovision now support no wait return flags
Application list related commands now support an optional argument to limit the number of results
Deployed application info can now optionally include health states
Numerous documentation improvements and corrections
ChaosContext (context) and ChaosTargetFilter (chaos-target-filter) arguments are added to Chaos start command (#62)
Add test structure to verify correct HTTP request generation
Update provision application type command to match the latest Service Fabric runtime, now a custom command
Add command to get container logs deployed on node

3.0.0

Rename compose deployment creation and upgrade progress commands to accept 'deployment-name' as identifier (#44)
Fix incorrect parsing error when updating service description load metrics (#47)
Fix incorrect application upgrade argument names (#37)

2.0.0

Update to official 6.0 Service Fabric SDK
Report cluster health command added
Report health commands now have an immediate argument to tell the Fabric gateway to send the report immediately
Get cluster configuration and upgrade configuration for stand alone clusters commands added
Added start and update cluster upgrade commands
Start node command removed (use enable node)
Stop node command removed (use disable node)
Added information about new Fabric name hierarchical delimiter (~)
Health commands now include statistics, can be optionally removed
Limited set of repair manager commands added
Infrastructure service commands no longer accept a callback function
Docker compose commands have had arguments renamed to reflect Service Fabric API changes
Added support to upgrade Docker compose deployments

1.2.0rc2

Updating to Service Fabric 6.0 SDK release candidate
Added support and testing for Python 3.5, for ease of install on Ubuntu
Fixing number parsing in command arguments
Moving to different versions of pyopenssl and msrest
Improvement in application upload stability and performance
Add support for file share upload based on image store connection string

1.1.0

Added support for authenticating to clusters with AAD (#10)
Improved application upload performance (#11)

1.0.1

Fixed missing helps module.

1.0.0

Initial release.

sfctl dependencies

adal applicationinsights future msrestazure portalocker psutil six tqdm

FAQs

What is sfctl?

Azure Service Fabric command line. Visit Snyk Advisor to see a full health score report for sfctl, including popularity, security, maintenance & community analysis.

Is sfctl popular?

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

Is sfctl well maintained?

We found indications that sfctl maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sfctl safe to use?

The python package sfctl 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 4 November-2024, at 21:48 (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