From 2ea8b78d63e39603acaf1aad8683e9690efb6711 Mon Sep 17 00:00:00 2001 From: "Vanya A. Sergeev" Date: Tue, 16 May 2023 02:03:16 -0500 Subject: [PATCH] migrate from module to package --- README.md | 6 +++--- docs/index.md | 2 +- docs/installation.md | 4 ++-- msgpack.org.md | 6 +++--- setup.py | 3 ++- umsgpack.py => umsgpack/__init__.py | 0 umsgpack.pyi => umsgpack/__init__.pyi | 0 7 files changed, 11 insertions(+), 10 deletions(-) rename umsgpack.py => umsgpack/__init__.py (100%) rename umsgpack.pyi => umsgpack/__init__.pyi (100%) diff --git a/README.md b/README.md index d6cdda7..4d40466 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ u-msgpack-python is a lightweight [MessagePack](http://msgpack.org/) serializer and deserializer module written in pure Python, compatible with Python 2 and 3, as well CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest [MessagePack specification](https://github.com/msgpack/msgpack/blob/master/spec.md). In particular, it supports the new binary, UTF-8 string, application-defined ext, and timestamp types. -u-msgpack-python is currently distributed on [PyPI](https://pypi.python.org/pypi/u-msgpack-python) and as a single file: [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py). +u-msgpack-python is currently distributed as a package on [PyPI](https://pypi.python.org/pypi/u-msgpack-python) and as a single file module. ## Installation @@ -16,9 +16,9 @@ With easy_install: $ easy_install u-msgpack-python ``` -or simply drop [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py) into your project! +or simply drop `umsgpack.py` into your project! ``` text -$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py +$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack/__init__.py -O umsgpack.py ``` ## Examples diff --git a/docs/index.md b/docs/index.md index 0c39881..f18f8ff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ [u-msgpack-python](https://github.com/vsergeev/u-msgpack-python) is a lightweight [MessagePack](http://msgpack.org/) serializer and deserializer module written in pure Python, compatible with Python 2 and 3, as well CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest [MessagePack specification](https://github.com/msgpack/msgpack/blob/master/spec.md). In particular, it supports the new binary, UTF-8 string, application-defined ext, and timestamp types. -u-msgpack-python is currently distributed on [PyPI](https://pypi.python.org/pypi/u-msgpack-python) and as a single file: [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py). +u-msgpack-python is currently distributed as a package on [PyPI](https://pypi.python.org/pypi/u-msgpack-python) and as a single file module. ## Contents diff --git a/docs/installation.md b/docs/installation.md index 3da50a3..8651fd6 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -12,8 +12,8 @@ Install with easy_install: $ easy_install u-msgpack-python ``` -or simply drop [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py) into your project! +or simply drop `umsgpack.py` into your project! ``` text -$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py +$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack/__init__.py -O umsgpack.py ``` diff --git a/msgpack.org.md b/msgpack.org.md index a832e26..d508bf0 100644 --- a/msgpack.org.md +++ b/msgpack.org.md @@ -2,7 +2,7 @@ u-msgpack-python is a lightweight [MessagePack](http://msgpack.org/) serializer and deserializer module written in pure Python, compatible with Python 2 and 3, as well CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest [MessagePack specification](https://github.com/msgpack/msgpack/blob/master/spec.md). -u-msgpack-python is currently distributed on PyPI: https://pypi.python.org/pypi/u-msgpack-python and as a single file: [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py) +u-msgpack-python is currently distributed as a package on PyPI: https://pypi.python.org/pypi/u-msgpack-python and as a single file module. ## Installation @@ -16,9 +16,9 @@ With easy_install: $ easy_install u-msgpack-python ``` -or simply drop [umsgpack.py](https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py) into your project! +or simply drop `umsgpack.py` into your project! ``` text -$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack.py +$ wget https://raw.github.com/vsergeev/u-msgpack-python/master/umsgpack/__init__.py -O umsgpack.py ``` ## Examples diff --git a/setup.py b/setup.py index ced0b12..5d5ecc3 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,8 @@ author='vsergeev', author_email='v@sergeev.io', url='https://github.com/vsergeev/u-msgpack-python', - py_modules=['umsgpack'], + packages=['umsgpack'], + package_data={'umsgpack': ['*.pyi', 'py.typed']}, long_description="""u-msgpack-python is a lightweight `MessagePack `_ serializer and deserializer module written in pure Python, compatible with both Python 2 and Python 3, as well as CPython and PyPy implementations of Python. u-msgpack-python is fully compliant with the latest `MessagePack specification `_. In particular, it supports the new binary, UTF-8 string, and application-defined ext types. See https://github.com/vsergeev/u-msgpack-python for more information.""", classifiers=[ "Development Status :: 5 - Production/Stable", diff --git a/umsgpack.py b/umsgpack/__init__.py similarity index 100% rename from umsgpack.py rename to umsgpack/__init__.py diff --git a/umsgpack.pyi b/umsgpack/__init__.pyi similarity index 100% rename from umsgpack.pyi rename to umsgpack/__init__.pyi