Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ライセンスの追加と、PyPIに設定するメタ情報の追加。 #116

Merged
merged 3 commits into from
Nov 2, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: lint test docs
.PHONY: lint test docs publish

ONLY=""

Expand All @@ -22,3 +22,5 @@ endif
docs:
cd docs && poetry run make html

publish:
poetry publish --build
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# annofab-3dpc-editor-cli
Annofabの3次元プロジェクトを操作するためのCLIです。

[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annofab-3dpc-editor-cli.svg?branch=master)](https://app.travis-ci.com/kurusugawa-computer/annofab-3dpc-editor-cli)
[![PyPI version](https://badge.fury.io/py/annofab-3dpc-editor-cli.svg)](https://badge.fury.io/py/annofab-3dpc-editor-cli)
[![Python Versions](https://img.shields.io/pypi/pyversions/annofab-3dpc-editor-cli.svg)](https://pypi.org/project/annofab-3dpc-editor-cli)
[![Documentation Status](https://readthedocs.org/projects/annofab-3dpc-editor-cli/badge/?version=latest)](https://annofab-3dpc-editor-cli.readthedocs.io/ja/latest/?badge=latest)



## Install

```
$ pip install annofab-3dpc-editor-cli

```

## コマンドサンプル
https://annofab-3dpc-editor-cli.readthedocs.io/ja/latest/user_guide/command_sample.html 参照
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ReadTheDocsのリンクを追加



### バージョンの確認方法

Expand All @@ -15,7 +25,7 @@ $ anno3d version
annofab-3dpc-editor-cli 0.1.10a1
```


--------------
## 開発環境

* poetry
Expand All @@ -31,12 +41,6 @@ poetryのインストール手順は、このファイル下部の`poetryのイ
poetry install
```

----

## コマンドサンプル
https://github.com/kurusugawa-computer/annofab-3dpc-editor-cli/tree/master/docs/user_guide/command_sample.md 参照

----


## poetryのインストール手順
Expand Down Expand Up @@ -122,3 +126,11 @@ fish:
pipx install poetry
poetry completions bash | sudo tee /etc/bash_completion.d/poetry.bash-completion
```

## PyPIへの公開

```
$ make publish
```


16 changes: 15 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
[tool.poetry]
name = "annofab-3dpc-editor-cli"
version = "0.1.10a1"
description = ""
description = "Annofabの3次元プロジェクトを操作するためのCLIです。"
authors = ["Kurusugawa Computer Inc."]
repository="https://github.com/kurusugawa-computer/annofab-3dpc-editor-cli"
readme="README.md"
classifiers = [
"Intended Audience :: Developers",
"Environment :: Console",
"Programming Language :: Python",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Utilities",
"Operating System :: OS Independent",
]
Comment on lines +9 to +19
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awscliを参考にして当たり障りがない項目を追加した。
https://pypi.org/classifiers/


packages = [
{ include = "anno3d" }
]
Expand Down