Publish documentation with CD #238

DifferentialOrange · 2022-10-07T11:55:10Z

Follows #237

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Extract package version in documentation (see "Usage from Sphinx" in [1]). 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 5.0.2 was chosen due to Python 3.5 support, latest version 7.0.5 supports only Python 3.7+. Extract package version in documentation (see "Usage from Sphinx" in [1]). 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 5.0.2 was chosen due to Python 3.5 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 5.0.2 was chosen due to Python 3.5 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 5.0.2 was chosen due to Python 3.5 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

It seems that Windows CI pipeline creates `install` folder, so running `make install` results in "'install' is up to date." and tests failing with "No module named 'msgpack'". Part of #238

It seems that setuptools cannot automatically interpret "install latest supported by current Python version" directive since it's trying to install pandas 1.5.0 (supports only Python >= 3.8) for Python 3.6 pipeline. Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies and CI pipelines for Python 3.6 and Python 3.7 fail with "No module named 'numpy'" on pandas install. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 5.0.2 was chosen due to Python 3.5 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

setuptool_scm [1] package is a recommended way to set package version with git [2]. Version 6.4.2 was chosen due to Python 3.6 support, latest version 7.0.5 supports only Python 3.7+. Package version is displayed in documentation, so after this patch documentation for master branch won't be confused with the last tagged one. Version file is created when a user installs the package with `pip install` or on sources packing with `python setup.py bdist_wheel` command (readthedocs building pipelines install the package). If one would simply clone the repo, package `__version__` would be a `'dev'` placeholder. 1. https://pypi.org/project/setuptools-scm/ 2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ Part of #238

Using `pip install .` instead of `python setup.py install` is a modern way to install local package [1]. With outdated way, setuptools+pip fail to resolve dependencies for different versions (in our case, Python 3.6 and Python 3.7 runs will fail with "No module named 'numpy'" on pandas install while trying to install unsupported latest version). Excessive build_py stage is also skipped. 1. https://setuptools.pypa.io/en/latest/userguide/quickstart.html Part of #238

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange · 2022-10-21T13:44:54Z

Now webhooks and applications are set up. Docs should build for each master update. They are also built for pull requests so it is possible to review doc without any local build.

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

Overview This release introduces the support of extention types (decimal, uuid, error, datetime, interval) in MessagePack, various IProto features support (feature discovery and push protocol) and major infrastructure updates (scm version computation, full documentation for external and internal API both as code docstrings and readthedocs HTML, deb and RPM packages, and everything is processed with CI/CD pipelines). Breaking changes This release should not break any existing behavior. New features - Backport ConnectionPool support for Python 3.6 (PR #245). - Support iproto feature discovery (#206). - Decimal type support (#203). - UUID type support (#202). - Support extra information for iproto errors (#232). - Error extension type support (#232). - Datetime type support and tarantool.Datetime type (#204, PR #252). Tarantool datetime objects are decoded to `tarantool.Datetime` type. `tarantool.Datetime` may be encoded to Tarantool datetime objects. You can create `tarantool.Datetime` objects either from MessagePack data or by using the same API as in Tarantool: ```python dt1 = tarantool.Datetime(year=2022, month=8, day=31, hour=18, minute=7, sec=54, nsec=308543321) dt2 = tarantool.Datetime(timestamp=1661969274) dt3 = tarantool.Datetime(timestamp=1661969274, nsec=308543321) ``` `tarantool.Datetime` exposes `year`, `month`, `day`, `hour`, `minute`, `sec`, `nsec`, `timestamp` and `value` (integer epoch time with nanoseconds precision) properties if you need to convert `tarantool.Datetime` to any other kind of datetime object: ```python pdt = pandas.Timestamp(year=dt.year, month=dt.month, day=dt.day, hour=dt.hour, minute=dt.minute, second=dt.sec, microsecond=(dt.nsec // 1000), nanosecond=(dt.nsec % 1000)) ``` Use `tzoffset` parameter to set up offset timezone: ```python dt = tarantool.Datetime(year=2022, month=8, day=31, hour=18, minute=7, sec=54, nsec=308543321, tzoffset=180) ``` You may use `tzoffset` property to get timezone offset of a datetime object. Use `tz` parameter to set up timezone name: ```python dt = tarantool.Datetime(year=2022, month=8, day=31, hour=18, minute=7, sec=54, nsec=308543321, tz='Europe/Moscow') ``` If both `tz` and `tzoffset` is specified, `tz` is used. You may use `tz` property to get timezone name of a datetime object. `timestamp_since_utc_epoch` is a parameter to set timestamp convertion behavior for timezone-aware datetimes. If ``False`` (default), behaves similar to Tarantool `datetime.new()`: ```python >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=False) >>> dt datetime: Timestamp('2022-01-01 00:00:00'), tz: "" >>> dt.timestamp 1640995200.0 >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow', ... timestamp_since_utc_epoch=False) >>> dt datetime: Timestamp('2022-01-01 00:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow" >>> dt.timestamp 1640984400.0 ``` Thus, if ``False``, datetime is computed from timestamp since epoch and then timezone is applied without any convertion. In that case, `dt.timestamp` won't be equal to initialization `timestamp` for all timezones with non-zero offset. If ``True``, behaves similar to `pandas.Timestamp`: ```python >>> dt = tarantool.Datetime(timestamp=1640995200, timestamp_since_utc_epoch=True) >>> dt datetime: Timestamp('2022-01-01 00:00:00'), tz: "" >>> dt.timestamp 1640995200.0 >>> dt = tarantool.Datetime(timestamp=1640995200, tz='Europe/Moscow', ... timestamp_since_utc_epoch=True) >>> dt datetime: Timestamp('2022-01-01 03:00:00+0300', tz='Europe/Moscow'), tz: "Europe/Moscow" >>> dt.timestamp 1640995200.0 ``` Thus, if ``True``, datetime is computed in a way that `dt.timestamp` will always be equal to initialization `timestamp`. - Datetime interval type support and tarantool.Interval type (#229). Tarantool datetime interval objects are decoded to `tarantool.Interval` type. `tarantool.Interval` may be encoded to Tarantool interval objects. You can create `tarantool.Interval` objects either from MessagePack data or by using the same API as in Tarantool: ```python di = tarantool.Interval(year=-1, month=2, day=3, hour=4, minute=-5, sec=6, nsec=308543321, adjust=tarantool.IntervalAdjust.NONE) ``` Its attributes (same as in init API) are exposed, so you can use them if needed. - Datetime interval arithmetic support (#229). Valid operations: - `tarantool.Datetime` + `tarantool.Interval` = `tarantool.Datetime` - `tarantool.Datetime` - `tarantool.Interval` = `tarantool.Datetime` - `tarantool.Datetime` - `tarantool.Datetime` = `tarantool.Interval` - `tarantool.Interval` + `tarantool.Interval` = `tarantool.Interval` - `tarantool.Interval` - `tarantool.Interval` = `tarantool.Interval` Since `tarantool.Interval` could contain `month` and `year` fields and such operations could be ambiguous, you can use `adjust` field to tune the logic. The behavior is the same as in Tarantool, see [Interval arithmetic RFC](https://github.com/tarantool/tarantool/wiki/Datetime-Internals#interval-arithmetic). - `tarantool.IntervalAdjust.NONE` -- only truncation toward the end of month performed (default mode). ```python >>> dt = tarantool.Datetime(year=2022, month=3, day=31) datetime: Timestamp('2022-03-31 00:00:00'), tz: "" >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.NONE) >>> dt + di datetime: Timestamp('2022-04-30 00:00:00'), tz: "" ``` - `tarantool.IntervalAdjust.EXCESS` -- overflow mode, without any snap or truncation to the end of month, straight addition of days in month, stopping over month boundaries if there is less number of days. ```python >>> dt = tarantool.Datetime(year=2022, month=1, day=31) datetime: Timestamp('2022-01-31 00:00:00'), tz: "" >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.EXCESS) >>> dt + di datetime: Timestamp('2022-03-02 00:00:00'), tz: "" ``` - `tarantool.IntervalAdjust.LAST` -- mode when day snaps to the end of month, if happens. ```python >>> dt = tarantool.Datetime(year=2022, month=2, day=28) datetime: Timestamp('2022-02-28 00:00:00'), tz: "" >>> di = tarantool.Interval(month=1, adjust=tarantool.IntervalAdjust.LAST) >>> dt + di datetime: Timestamp('2022-03-31 00:00:00'), tz: "" ``` - Full documentation of internal and external API (#67). Bugfixes - Allow any MessagePack supported type as a request key (#240). - Make connection close idempotent (#250). Infrastructure - Use git version to set package version (#238). - Test pip install from branch (PR #241). - Pack and publish pip, RPM and deb packages with GitHub Actions (#164, #198). - Publish on readthedocs with CI/CD (including PRs) (#67).

DifferentialOrange self-assigned this Oct 7, 2022

DifferentialOrange added ci 2sp labels Oct 7, 2022

DifferentialOrange changed the title ~~Publish documentation with CI~~ Publish documentation with CD Oct 7, 2022

DifferentialOrange added documentation Improvements or additions to documentation teamE labels Oct 7, 2022

DifferentialOrange added a commit that referenced this issue Oct 7, 2022

doc: remove outdated upload script

ed237c3

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 7, 2022

doc: use readthedocs files structure

f14e2c7

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange mentioned this issue Oct 7, 2022

Publish on readthedocs #239

Merged

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

doc: remove outdated upload script

fd004b4

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

doc: use readthedocs files structure

9fa3ce6

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

setup: get package requirements from file

e2d0d01

Part of #238

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

setup: fix MANIFEST

63ef2ed

Part of #238

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

setup: get package requirements from file

b75fca4

Part of #238

DifferentialOrange added a commit that referenced this issue Oct 10, 2022

setup: fix MANIFEST

244aa2d

Part of #238

DifferentialOrange mentioned this issue Oct 10, 2022

Make documentation relevant #237

Merged

DifferentialOrange added a commit that referenced this issue Oct 18, 2022

doc: remove outdated upload script

f5a6b41

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 18, 2022

doc: use readthedocs files structure

504d671

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

setup: do not include test files

b64bf49

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

setup: do not include test files

fcae5ba

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

doc: remove outdated upload script

ce80a35

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

doc: use readthedocs files structure

56b7ebf

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

doc: remove outdated upload script

d0fba3e

Remove script and make command for PyPi docs since module use readthedocs now. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 21, 2022

doc: use readthedocs files structure

708902e

Make structure similar to readthedocs tutorial [1]. 1. https://docs.readthedocs.io/en/stable/tutorial/ Part of #238

DifferentialOrange closed this as completed Oct 21, 2022

DifferentialOrange added a commit that referenced this issue Oct 28, 2022

setup: do not include test files

c2f3f08

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

DifferentialOrange added a commit that referenced this issue Oct 31, 2022

setup: do not include test files

69e0547

Include only `tarantool` package and subpackage code on install. Before this patch, test suites were installed as well. Part of #238

DifferentialOrange mentioned this issue Nov 9, 2022

Release 0.10.0 #258

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish documentation with CD #238

Publish documentation with CD #238

DifferentialOrange commented Oct 7, 2022

DifferentialOrange commented Oct 21, 2022

Publish documentation with CD #238

Publish documentation with CD #238

Comments

DifferentialOrange commented Oct 7, 2022

DifferentialOrange commented Oct 21, 2022