Package Health Score

75 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 9
Forks: 0
Contributors: 20

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 12, 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 annofabcli 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: 56
Open PR: 1
Last Release: 11 days ago
Last Commit: 8 days ago

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

We found that annofabcli 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 annofabcli 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 annofabcli 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: <4.0,>=3.8

Age: 5 years
Latest Release: 11 days ago
Dependencies: 10 Direct
Versions: 357
Maintainers: 3
Wheels: OS Independent

Readme

annofab-cli

AnnofabのCLI(Command Line Interface)ツールです。「タスクの一括差し戻し」や、「タスク一覧出力」など、Annofabの画面で実施するには時間がかかる操作を、コマンドとして提供しています。

注意

作者または著作権者は、ソフトウェアに関してなんら責任を負いません。
予告なく互換性のない変更がある可能性をご了承ください。
Annofabプロジェクトに大きな変更を及ぼすコマンドも存在します。間違えて実行してしまわないよう、注意してご利用ください。

廃止予定

2022-11-01 以降

JMESPathを指定できる --queryを削除します。使いどころがあまりないのと、jqコマンドでも対応できるためです。
--wait_optionsを削除します。使いどころがあまりないためです。

Requirements

Python 3.8+

Install

$ pip install annofabcli

https://pypi.org/project/annofabcli/

Windows用の実行ファイルを利用する場合

GitHubのリリースページからannofabcli-vX.X.X-windows.zipをダウンロードしてください。 zipの中にあるannofabcli.exeが実行ファイルになります。

Annofabの認証情報の設定

https://annofab-cli.readthedocs.io/ja/latest/user_guide/configurations.html 参照

使い方

https://annofab-cli.readthedocs.io/ja/latest/user_guide/index.html 参照

コマンド一覧

https://annofab-cli.readthedocs.io/ja/latest/command_reference/index.html

よくある使い方

受入完了状態のタスクを差し戻す

"car"ラベルの"occluded"属性のアノテーションルールに間違いがあったため、以下の条件を満たすタスクを一括で差し戻します。

"car"ラベルの"occluded"チェックボックスがONのアノテーションが、タスクに1つ以上存在する。

前提条件

プロジェクトのオーナが、annofabcliコマンドを実行する

# 受入完了のタスクのtask_id一覧を、acceptance_complete_task_id.txtに出力する。
$ annofabcli task list --project_id prj1  --task_query '{"status": "complete","phase":"acceptance"}' \
 --format task_id_list --output acceptance_complete_task_id.txt

# 受入完了タスクの中で、 "car"ラベルの"occluded"チェックボックスがONのアノテーションの個数を出力する。
$ annofabcli annotation list_count --project_id prj1 --task_id file://task.txt --output annotation_count.csv \
 --annotation_query '{"label_name_en": "car", "attributes":[{"additional_data_definition_name_en": "occluded", "flag": true}]}'

# annotation_count.csvを表計算ソフトで開き、アノテーションの個数が1個以上のタスクのtask_id一覧を、task_id.txtに保存する。

# task_id.txtに記載されたタスクを差し戻す。検査コメントは「carラベルのoccluded属性を見直してください」。
# 差し戻したタスクには、最後のannotation phaseを担当したユーザを割り当てる（画面と同じ動き）。
$ annofabcli task reject --project_id prj1 --task_id file://tasks.txt --cancel_acceptance \
  --comment "carラベルのoccluded属性を見直してください"

補足

Windowsでannofabcliを使う場合

WindowsのコマンドプロンプトやPowerShellでannofabcliを使う場合、JSON文字列内の二重引用をエスケープする必要があります。

> annofabcli task list --project_id prj1  --task_query '{"\status\": \"complete\"}'

annofabcli dependencies

dictdiffer isodate jmespath more-itertools numpy pillow pyquery python-datauri pyyaml requests

FAQs

What is annofabcli?

Utility Command Line Interface for AnnoFab. Visit Snyk Advisor to see a full health score report for annofabcli, including popularity, security, maintenance & community analysis.

Is annofabcli popular?

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

Is annofabcli well maintained?

We found that annofabcli 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 annofabcli safe to use?

The python package annofabcli 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 20 November-2024, at 11:52 (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