feat: CI/CD and RTD

[geminixiang]

Feature

• chore: Add devcontainer configuration #48 devcontainer - based on python2.7 and python3.8
• docs: Setup ReadTheDocs and clean up documentation #49 Read the docs
  • example https://geminixiangdictrack.readthedocs.io/en/latest/index.html
  • 補個快速指令 ./docs 本地啟動
  • ignore sphinx generate html build/docs/_build/
• fix: Fix tests for limiters and conditions #50 修正 unittest 不穩定
• feat: Add GitHub Actions CI/CD workflows #47 CI - 只能自己建立 python2.7 環境了 ref. python2.7 will be removed from the python-versions on June 19 actions/setup-python#672

• CD https://test.pypi.org/project/fork-dictrack-geminixiang/

pip install -i https://test.pypi.org/simple/ fork-dictrack-geminixiang

打包成果跟之前一樣

vscode ➜ ~/.local/lib/python3.8/site-packages $ tree ./dictrack
./dictrack
├── conditions
│   ├── base.py
│   ├── __init__.py
│   ├── keys.py
│   └── __pycache__
│       ├── base.cpython-38.pyc
│       ├── __init__.cpython-38.pyc
│       └── keys.cpython-38.pyc
├── data_caches
│   ├── base.py
│   ├── __init__.py
│   ├── memory.py
│   ├── __pycache__
│   │   ├── base.cpython-38.pyc
│   │   ├── __init__.cpython-38.pyc
│   │   ├── memory.cpython-38.pyc
│   │   └── redis.cpython-38.pyc
│   └── redis.py
├── data_stores
│   ├── base.py
│   ├── __init__.py
│   ├── mongodb.py
│   └── __pycache__
│       ├── base.cpython-38.pyc
│       ├── __init__.cpython-38.pyc
│       └── mongodb.cpython-38.pyc
├── events.py
├── __init__.py
├── limiters
│   ├── base.py
│   ├── count.py
│   ├── __init__.py
│   ├── __pycache__
│   │   ├── base.cpython-38.pyc
│   │   ├── count.cpython-38.pyc
│   │   ├── __init__.cpython-38.pyc
│   │   └── time.cpython-38.pyc
│   └── time.py
├── manager.py
├── __pycache__
│   ├── events.cpython-38.pyc
│   ├── __init__.cpython-38.pyc
│   └── manager.cpython-38.pyc
├── trackers
│   ├── base.py
│   ├── __init__.py
│   ├── numerics
│   │   ├── accumulation.py
│   │   ├── count.py
│   │   ├── __init__.py
│   │   ├── numeric.py
│   │   └── __pycache__
│   │       ├── accumulation.cpython-38.pyc
│   │       ├── count.cpython-38.pyc
│   │       ├── __init__.cpython-38.pyc
│   │       └── numeric.cpython-38.pyc
│   └── __pycache__
│       ├── base.cpython-38.pyc
│       └── __init__.cpython-38.pyc
└── utils
    ├── errors.py
    ├── __init__.py
    ├── logger.py
    ├── __pycache__
    │   ├── errors.cpython-38.pyc
    │   ├── __init__.cpython-38.pyc
    │   ├── logger.cpython-38.pyc
    │   └── utils.cpython-38.pyc
    └── utils.py

15 directories, 54 files

Test

vscode ➜ /workspaces/dictrack (main) $ python2 -m pytest app/
============================================ test session starts ============================================
platform linux2 -- Python 2.7.18, pytest-4.6.11, py-1.11.0, pluggy-0.13.1
rootdir: /workspaces/dictrack
plugins: cov-2.12.1
collected 19 items                                                                                          

app/tests/test_conditions.py .................                                                        [ 89%]
app/tests/test_limiters.py ..                                                                         [100%]

========================================= 19 passed in 0.07 seconds =========================================
vscode ➜ /workspaces/dictrack (main) $ python3 -m pytest app/
============================================ test session starts ============================================
platform linux -- Python 3.8.10, pytest-8.3.5, pluggy-1.5.0
rootdir: /workspaces/dictrack
collected 19 items                                                                                          

app/tests/test_conditions.py .................                                                        [ 89%]
app/tests/test_limiters.py ..                                                                         [100%]

============================================ 19 passed in 0.04s =============================================

TODO

• github action 啟動
• 更新 /app/dictrack/__init__.py 版號
• 需要到 Read the docs 新增一下專案 https://app.readthedocs.org/dashboard/

[geminixiang]

時好時壞的測試，直接給固定 now_ts 下去測試