Add PyPI configuration

See https://packaging.python.org/tutorials/packaging-projects

Makefile

@@ -0,0 +1,11 @@
+build: clean
+	python setup.py sdist bdist_wheel
+
+upload_to_test_pypi:
+	python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+upload_to_pypi:
+	python -m twine upload dist/*
+
+clean:
+	-rm -r dist/

README.md

@@ -2,6 +2,7 @@
 <h1 align='center'>Simulated Time</h1>
 
 <p align="center">A testing (and partial) replacement for Python's <code>time</code> package, for fully-controlled time-dependent tests.</p>
+<p align="center"><a href="https://pypi.org/project/stime"><img alt="PyPI" src="https://img.shields.io/pypi/v/stime.svg" /></a></p>
 
 <br /><br />
 
@@ -72,6 +73,46 @@ class TestTimer(unittest.TestCase):
 - ④ Fast-forward when convenient...
 - ⑤ or progress one second at a time!
 
+Development
+-----------
+
+### Getting started
+
+Optionally, create a virtual environment for this project and activate it.
+
+```bash
+python -m venv timer_venv # assuming Python 3
+. timer_venv/bin/activate
+```
+
+Then do your thing!
+
+```bash
+# run the example test suite:
+python test_timer.py
+
+# once you're done deactivate the virtual environment if you use one:
+deactivate
+```
+
+### Release
+
+```bash
+# Install the latest setuptools and wheel (in a virtual environment eventually)
+pip install --upgrade setuptools wheel
+
+# Update the package version number and tag it:
+vim setup.py
+git tag -a 'v1.0.0' -m 'Initial release'
+git push origin master --tags
+
+# Build the distribution files
+make build
+
+# And upload them to PyPI
+make upload_to_pypi
+```
+
 Credits
 -------
 

setup.py

@@ -0,0 +1,21 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="stime",
+    version="0.1.2",
+    author="Gonzalo Bulnes Guilpain",
+    author_email="[email protected]",
+    description="A testing (and partial) replacement for the time package, for fully-controlled time-dependent tests.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/gonzalo-bulnes/stime",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "Operating System :: OS Independent",
+    ],
+)