diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index ce7485a52..21ec03c2f 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -20,10 +20,14 @@ jobs: with: python-version: '3.9' - - name: Install dependencies and set version + - name: Install dependencies + run: pip install poetry dunamai + + - name: Set version run: | - pip install poetry dunamai - poetry version $(dunamai from any --no-metadata --style pep440) + RX_VERSION=$(dunamai from any --no-metadata --style pep440) + poetry version $RX_VERSION + poetry run echo "__version__ = \"$RX_VERSION\"" > reactivex/_version.py - name: Build package run: poetry build diff --git a/README.rst b/README.rst index 9247fc755..765161a74 100644 --- a/README.rst +++ b/README.rst @@ -39,11 +39,11 @@ install: About ReactiveX --------------- -ReactiveX for Python (RxPY) is a set of libraries for composing asynchronous and -event-based programs using observable sequences and pipable query operators in Python. -Using Rx, developers represent asynchronous data streams with Observables, query -asynchronous data streams using operators, and parameterize concurrency in data/event -streams using Schedulers. +ReactiveX for Python (RxPY) is a library for composing asynchronous and event-based +programs using observable sequences and pipable query operators in Python. Using Rx, +developers represent asynchronous data streams with Observables, query asynchronous data +streams using operators, and parameterize concurrency in data/event streams using +Schedulers. .. code:: python @@ -67,7 +67,7 @@ Read the `documentation the principles of ReactiveX and get the complete reference of the available operators. -If you need to migrate code from RxPY v1.x, read the `migration +If you need to migrate code from RxPY v1.x or v3.x, read the `migration `_ section. There is also a list of third party documentation available `here diff --git a/docs/index.rst b/docs/index.rst index a34c83845..ee37f97f1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,11 +3,12 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -The Reactive Extensions for Python (RxPY) -========================================== +ReactiveX for Python (RxPY) +=========================== -RxPY is a library for composing asynchronous and event-based programs using -observable collections and pipable query operators in Python. +ReactiveX for Python (RxPY) is a library for composing asynchronous and +event-based programs using observable collections and pipable query +operators in Python. .. toctree:: :maxdepth: 2 diff --git a/docs/installation.rst b/docs/installation.rst index 63638dfdc..3ed0ae325 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,7 +3,8 @@ Installation ============ -ReactiveX for Python v4.x runs on `Python `__ 3. To install: +ReactiveX for Python (RxPY) v4.x runs on `Python +`__ 3. To install: .. code:: console diff --git a/docs/license.rst b/docs/license.rst index a3cc79093..ab5bbae4b 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,7 +1,7 @@ The MIT License =============== -Copyright 2013-2019, Dag Brattli, Microsoft Corp., and Contributors. +Copyright 2013-2022, Dag Brattli, Microsoft Corp., and Contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/docs/migration.rst b/docs/migration.rst index bb101f20a..577abd3c7 100644 --- a/docs/migration.rst +++ b/docs/migration.rst @@ -20,10 +20,10 @@ current Python standards: .. code:: python - import reactivex + import reactivex as rx from reactivex import operators as ops - reactivex.of("Alpha", "Beta", "Gamma", "Delta", "Epsilon").pipe( + rx.of("Alpha", "Beta", "Gamma", "Delta", "Epsilon").pipe( ops.map(lambda s: len(s)), ops.filter(lambda i: i >= 5) ).subscribe(lambda value: print("Received {0}".format(value))) diff --git a/pyproject.toml b/pyproject.toml index 9739ee765..6d3dbf774 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "ReactiveX" -version = "0.0.0" +version = "0.0.0" # NOTE: will be updated by publish script description = "ReactiveX (Rx) for Python" readme = "README.rst" authors = ["Dag Brattli "] diff --git a/reactivex/_version.py b/reactivex/_version.py index de785a4ad..ef6d98636 100644 --- a/reactivex/_version.py +++ b/reactivex/_version.py @@ -1 +1 @@ -__version__ = "$(dunamai from any)" +__version__ = "0.0.0" # NOTE: version will be written by publish script