annofab-3dpc-editor-cli


Nameannofab-3dpc-editor-cli JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/kurusugawa-computer/annofab-3dpc-editor-cli
SummaryAnnofabの3次元プロジェクトを操作するためのCLIです。
upload_time2023-08-30 18:47:15
maintainer
docs_urlNone
authorKurusugawa Computer Inc.
requires_python>=3.8,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls. 
            # 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 参照


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

```
$ anno3d version
annofab-3dpc-editor-cli 0.2.1
```

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

 * poetry
     * Poetry version 1.0.5
 * python 3.8
 
 
### 開発環境初期化

poetryのインストール手順は、このファイル下部の`poetryのインストール手順`を参照

```
poetry install
```



## poetryのインストール手順


poetryのインストール手順一例を以下に示す  
2020/05/21 ubuntu 18.04 にて確認

ローカルの環境に以下の手順でインストールする以外に，
python 3.8 および poetry の導入がなされた `docker/Dockerfile` を用いても良い．

### pyenv

システムにpython 3.8を直接インストールして使うなら`pyenv`は要らない

```
sudo apt-get update

sudo apt-get install build-essential libssl-dev zlib1g-dev libbz2-dev \
libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev \
xz-utils tk-dev libffi-dev liblzma-dev python-openssl git
```

```
curl https://pyenv.run | bash
``` 

コンソールに、以下のような設定すべき内容が出力されるので`.bashrc`などに設定

```
export PATH="/home/vagrant/.pyenv/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"
```

```
pyenv install 3.8.3
pyenv global 3.8.3
```

### pipx

直接 poetry をインストールするなら要らない

```
python -m pip install --user pipx
python -m pipx ensurepath
```

completionを効かせたいときは、`pipx completions` の実行結果に従って設定する

```
$ pipx completions

Add the appropriate command to your shell's config file
so that it is run on startup. You will likely have to restart
or re-login for the autocompletion to start working.

bash:
    eval "$(register-python-argcomplete pipx)"

zsh:
    To activate completions for zsh you need to have
    bashcompinit enabled in zsh:

    autoload -U bashcompinit
    bashcompinit

    Afterwards you can enable completion for pipx:

    eval "$(register-python-argcomplete pipx)"

tcsh:
    eval `register-python-argcomplete --shell tcsh pipx`

fish:
    register-python-argcomplete --shell fish pipx | .
```

### poetry

```
pipx install poetry
poetry completions bash | sudo tee /etc/bash_completion.d/poetry.bash-completion
```

## PyPIへの公開

```
$ make publish
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kurusugawa-computer/annofab-3dpc-editor-cli",
    "name": "annofab-3dpc-editor-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Kurusugawa Computer Inc.",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/82/c8/70281198a053d8e952686f0a76abee2596318208dcad6e3a4a1ab11fe06d/annofab-3dpc-editor-cli-0.2.1.tar.gz",
    "platform": null,
    "description": "# annofab-3dpc-editor-cli\nAnnofab\u306e3\u6b21\u5143\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3092\u64cd\u4f5c\u3059\u308b\u305f\u3081\u306eCLI\u3067\u3059\u3002\n\n[![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)\n[![PyPI version](https://badge.fury.io/py/annofab-3dpc-editor-cli.svg)](https://badge.fury.io/py/annofab-3dpc-editor-cli)\n[![Python Versions](https://img.shields.io/pypi/pyversions/annofab-3dpc-editor-cli.svg)](https://pypi.org/project/annofab-3dpc-editor-cli)\n[![Documentation Status](https://readthedocs.org/projects/annofab-3dpc-editor-cli/badge/?version=latest)](https://annofab-3dpc-editor-cli.readthedocs.io/ja/latest/?badge=latest)\n\n\n\n## Install\n\n```\n$ pip install annofab-3dpc-editor-cli\n```\n\n## \u30b3\u30de\u30f3\u30c9\u30b5\u30f3\u30d7\u30eb\nhttps://annofab-3dpc-editor-cli.readthedocs.io/ja/latest/user_guide/command_sample.html \u53c2\u7167\n\n\n### \u30d0\u30fc\u30b8\u30e7\u30f3\u306e\u78ba\u8a8d\u65b9\u6cd5\n\n```\n$ anno3d version\nannofab-3dpc-editor-cli 0.2.1\n```\n\n--------------\n## \u958b\u767a\u74b0\u5883\n\n * poetry\n     * Poetry version 1.0.5\n * python 3.8\n \n \n### \u958b\u767a\u74b0\u5883\u521d\u671f\u5316\n\npoetry\u306e\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u624b\u9806\u306f\u3001\u3053\u306e\u30d5\u30a1\u30a4\u30eb\u4e0b\u90e8\u306e`poetry\u306e\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u624b\u9806`\u3092\u53c2\u7167\n\n```\npoetry install\n```\n\n\n\n## poetry\u306e\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u624b\u9806\n\n\npoetry\u306e\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u624b\u9806\u4e00\u4f8b\u3092\u4ee5\u4e0b\u306b\u793a\u3059  \n2020/05/21 ubuntu 18.04 \u306b\u3066\u78ba\u8a8d\n\n\u30ed\u30fc\u30ab\u30eb\u306e\u74b0\u5883\u306b\u4ee5\u4e0b\u306e\u624b\u9806\u3067\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3059\u308b\u4ee5\u5916\u306b\uff0c\npython 3.8 \u304a\u3088\u3073 poetry \u306e\u5c0e\u5165\u304c\u306a\u3055\u308c\u305f `docker/Dockerfile` \u3092\u7528\u3044\u3066\u3082\u826f\u3044\uff0e\n\n### pyenv\n\n\u30b7\u30b9\u30c6\u30e0\u306bpython 3.8\u3092\u76f4\u63a5\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3057\u3066\u4f7f\u3046\u306a\u3089`pyenv`\u306f\u8981\u3089\u306a\u3044\n\n```\nsudo apt-get update\n\nsudo apt-get install build-essential libssl-dev zlib1g-dev libbz2-dev \\\nlibreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev \\\nxz-utils tk-dev libffi-dev liblzma-dev python-openssl git\n```\n\n```\ncurl https://pyenv.run | bash\n``` \n\n\u30b3\u30f3\u30bd\u30fc\u30eb\u306b\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306a\u8a2d\u5b9a\u3059\u3079\u304d\u5185\u5bb9\u304c\u51fa\u529b\u3055\u308c\u308b\u306e\u3067`.bashrc`\u306a\u3069\u306b\u8a2d\u5b9a\n\n```\nexport PATH=\"/home/vagrant/.pyenv/bin:$PATH\"\neval \"$(pyenv init -)\"\neval \"$(pyenv virtualenv-init -)\"\n```\n\n```\npyenv install 3.8.3\npyenv global 3.8.3\n```\n\n### pipx\n\n\u76f4\u63a5 poetry \u3092\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3059\u308b\u306a\u3089\u8981\u3089\u306a\u3044\n\n```\npython -m pip install --user pipx\npython -m pipx ensurepath\n```\n\ncompletion\u3092\u52b9\u304b\u305b\u305f\u3044\u3068\u304d\u306f\u3001`pipx completions` \u306e\u5b9f\u884c\u7d50\u679c\u306b\u5f93\u3063\u3066\u8a2d\u5b9a\u3059\u308b\n\n```\n$ pipx completions\n\nAdd the appropriate command to your shell's config file\nso that it is run on startup. You will likely have to restart\nor re-login for the autocompletion to start working.\n\nbash:\n    eval \"$(register-python-argcomplete pipx)\"\n\nzsh:\n    To activate completions for zsh you need to have\n    bashcompinit enabled in zsh:\n\n    autoload -U bashcompinit\n    bashcompinit\n\n    Afterwards you can enable completion for pipx:\n\n    eval \"$(register-python-argcomplete pipx)\"\n\ntcsh:\n    eval `register-python-argcomplete --shell tcsh pipx`\n\nfish:\n    register-python-argcomplete --shell fish pipx | .\n```\n\n### poetry\n\n```\npipx install poetry\npoetry completions bash | sudo tee /etc/bash_completion.d/poetry.bash-completion\n```\n\n## PyPI\u3078\u306e\u516c\u958b\n\n```\n$ make publish\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Annofab\u306e3\u6b21\u5143\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3092\u64cd\u4f5c\u3059\u308b\u305f\u3081\u306eCLI\u3067\u3059\u3002",
    "version": "0.2.1",
    "project_urls": {
        "Homepage": "https://github.com/kurusugawa-computer/annofab-3dpc-editor-cli",
        "Repository": "https://github.com/kurusugawa-computer/annofab-3dpc-editor-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "118c12298576b7c5f8406dfeca9e57aa0cf90171e3c2bb7d3093c7cc26b444c5",
                "md5": "939543b1c856354bf9aa5af7076afc48",
                "sha256": "a3d412616121762ff976364ddb9561e8bde00d19464010415c8b5cba9747d8cc"
            },
            "downloads": -1,
            "filename": "annofab_3dpc_editor_cli-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "939543b1c856354bf9aa5af7076afc48",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 50112,
            "upload_time": "2023-08-30T18:47:17",
            "upload_time_iso_8601": "2023-08-30T18:47:17.498529Z",
            "url": "https://files.pythonhosted.org/packages/11/8c/12298576b7c5f8406dfeca9e57aa0cf90171e3c2bb7d3093c7cc26b444c5/annofab_3dpc_editor_cli-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "82c870281198a053d8e952686f0a76abee2596318208dcad6e3a4a1ab11fe06d",
                "md5": "d10945faacf60283b11dfcd92fe406e9",
                "sha256": "a4ac4197f6f349e67242ccd3bbd55b02895a564f4e7eda38b5a17ec382cc47bb"
            },
            "downloads": -1,
            "filename": "annofab-3dpc-editor-cli-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d10945faacf60283b11dfcd92fe406e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 38429,
            "upload_time": "2023-08-30T18:47:15",
            "upload_time_iso_8601": "2023-08-30T18:47:15.851756Z",
            "url": "https://files.pythonhosted.org/packages/82/c8/70281198a053d8e952686f0a76abee2596318208dcad6e3a4a1ab11fe06d/annofab-3dpc-editor-cli-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-30 18:47:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kurusugawa-computer",
    "github_project": "annofab-3dpc-editor-cli",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "lcname": "annofab-3dpc-editor-cli"
}
Kurusugawa Computer Inc.
Elapsed time: 0.10098s