analysis-environment

Base repository for data analytsis

Requirements

OS: Ubuntu

How to install

Python

以下の手順に従って Python の仮想環境を構築してください。

1. 以下のようにして、必要モジュールをインストールしてください。

   sudo apt-get update; sudo apt-get install make build-essential libssl-dev zlib1g-dev \
   libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
   libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev

2. 以下のコマンドを実行して pyenv をインストールしてください。

   curl https://pyenv.run | bash

3. 以下のコマンドを実行して Python の仮想環境をインストールしてください。

   pyenv install 3.9.9

4. 以下のコマンドを実行して Python の仮想環境を有効化してください。

   pyenv local 3.9.9

Poetry

本リポジトリでは Poetry を使ってパッケージ管理を行います。以下の手順に従って依存関係をインストールしてください。

1. 公式ドキュメントに従って Poetry をインストールしてください。

2. 以下のコマンドを実行して依存するパッケージをインストールしてください。

   poetry install

3. 以下のコマンドを実行して Poetry の仮想環境をアクティベートしてください。

   poetry shell

4. Poetry の仮想環境を終了するには以下のコマンドを実行してください。

   exit

pre-commit

本リポジトリでは、リポジトリ内のファイルをクリーンに保つために pre-commit を使ってコミットの直前にファイルのチェックを行います。poetry install, poetry shell が済んだ状態で以下の手順に従ってください。

1. nvm 公式ドキュメント の手順に従って nvm のインストールを行ってください。

2. 以下のコマンドを実行して node のインストールと node 仮想環境のアクティベートを行ってください。

   nvm install --lts
   nvm use --lts

3. 以下のコマンドを実行して node パッケージのインストールを行ってください。

   npm ci

4. 以下のコマンドを実行して pre-commit hooks のインストールを行ってください。このコマンドが完了すると git commit を実行した直後に pre-commit によるファイルチェックが実行されます。

   pre-commit install

5. 以下のコマンドを実行すると pre-commit hooks に登録されているすべての hooks が実行されます。

   pre-commit run -a

Nox

本リポジトリでは、多数あるテストスイートの実行を簡単化するために Nox を使って仮想環境の構築を含めたコードの半自動テストを行います。以下の手順に従って、コードの lint と test が行われることを確認します。poetry install, poetry shell が済んだ状態で以下の手順に従ってください。

1. 以下のコマンドを実行すると Nox による半自動テストが行われます。

   nox

Documentation

本リポジトリでは MkDocs と mkdocstrings を使って Python の docstrings からドキュメントを自動生成します。poetry install, poetry shell が済んだ状態で以下の手順に従ってください。

1. 以下のコマンドを実行すると MkDocs のビルドが可能です。

   mkdocs build

   実行後に site ディレクトリが作成され、site/index.html をブラウザで読み込むことでドキュメントを読むことができます。

2. また以下のコマンドを実行すると、ブラウザが自動的に立ち上がりファイルの変更に応じて自動的にページが更新されるようになります。

   mkdocs serve