[ci] Prepare ReFrame for deployment to PyPI

README.md

@@ -4,7 +4,7 @@
 
 # ReFrame
 
-ReFrame is a new framework for writing regression tests for HPC systems.
+ReFrame is a framework for writing regression tests for HPC systems.
 The goal of this framework is to abstract away the complexity of the interactions with the system, separating the logic of a regression test from the low-level details, which pertain to the system configuration and setup.
 This allows users to write easily portable regression tests, focusing only on the functionality.
 
@@ -16,6 +16,31 @@ Writing system regression tests in a high-level modern programming language, lik
 Users can create their own test hierarchies, create test factories for generating multiple tests at the same time and also customize them in a simple and expressive way.
 
 
+## Getting ReFrame
+
+You may install ReFrame directly from [PyPI](https://pypi.org/project/ReFrame-HPC/) through `pip`:
+
+```bash
+pip install reframe-hpc
+```
+
+ReFrame will be available in your PATH:
+
+```bash
+reframe -V
+```
+
+Alternatively, and especially if you want to contribute back to the framework, you may clone this repository:
+
+```bash
+git clone https://github.com/eth-cscs/reframe.git
+cd reframe
+./bin/reframe -V
+```
+
+Finally, you may access all previous versions of ReFrame [here](https://github.com/eth-cscs/reframe/releases).
+
+
 ## Documentation
 
 You may find the official documentation of the latest release and the current master in the following links:

ci-scripts/deploy.sh

@@ -46,11 +46,13 @@ fi
 
 python3 -m venv venv.deployment
 source venv.deployment/bin/activate
-pip install --upgrade pip
+pip install --upgrade pip setuptools wheel twine
 pip install -r requirements.txt
 ./test_reframe.py
 git tag -a v$version -m "ReFrame $version"
 git push origin --tags
+python setup.py sdist bdist_wheel
+twine upload dist/*
 deactivate
 cd $oldpwd
 echo "Deployment was successful!"

setup.py

@@ -0,0 +1,31 @@
+import setuptools
+
+from reframe import VERSION
+
+with open('README.md') as read_me:
+    long_description = ''.join(read_me.readlines()[4:])
+
+setuptools.setup(
+    name='ReFrame-HPC',
+    version=VERSION,
+    author='CSCS Swiss National Supercomputing Center',
+    description='ReFrame is a framework for writing regression tests '
+                'for HPC systems',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/eth-cscs/reframe',
+    licence='BSD 3-Clause',
+    packages=setuptools.find_packages(exclude=['unittests']),
+    python_requires='>=3.5',
+    scripts=['bin/reframe'],
+    classifiers=(
+        'Development Status :: 5 - Production/Stable',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: MacOS',
+        'Operating System :: POSIX :: Linux',
+        'Environment :: Console'
+    ),
+)