[Task]: Improve project documentation on apache-beam pypi page.

[tvalentyn]

What needs to happen?

Current project summary is a very short paragraph: https://pypi.org/project/apache-beam/. We could add more content and useful pointers to that page, perhaps similar to https://pypi.org/project/scipy/.

Issue Priority

Priority: 3 (nice-to-have improvement)

Issue Components

• Component: Python SDK
• Component: Java SDK
• Component: Go SDK
• Component: Typescript SDK
• Component: IO connector
• Component: Beam YAML
• Component: Beam examples
• Component: Beam playground
• Component: Beam katas
• Component: Website
• Component: Spark Runner
• Component: Flink Runner
• Component: Samza Runner
• Component: Twister2 Runner
• Component: Hazelcast Jet Runner
• Component: Google Cloud Dataflow Runner

[rakeshcusat]

@tvalentyn / @damccorm should this be referring readme.md file instead.

from setuptools import setup

# read the contents of your README file
from pathlib import Path
this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
    name='an_example_package',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)

Scipy uses something similar. In that case there will be only one source of truth and get update automatically as soon as the readme file is updated.

What do you guys think?

[liferoad]

Good idea.