Restructuring for PyPI

Fingers crossed this actually works correctly?
RoadrunnerWMC · Jan 18, 2019 · 18ab233 · 18ab233
1 parent 6d8f7bd
commit 18ab233
Show file tree

Hide file tree

Showing 30 changed files with 10 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -23,8 +23,7 @@ suitable for use in applications written in Python, and in scripts to do more
 complex tasks than the command-line tools are capable of.
 
 As ndspy is written in pure Python, it is cross-platform and should run on all
-platforms Python supports. Additionally, all dependencies other than Python
-itself are optional.
+platforms Python supports.
 
 Interested? Read on to see some examples, or check the [API
 Reference](https://ndspy.readthedocs.io/en/latest/api.html) to see the
@@ -119,7 +118,8 @@ the following possibilities will probably work for you, though:
 If you want the very latest version of ndspy including features and bugfixes
 not yet in any official release, you can also download the code from the
 [GitHub repository](https://github.com/RoadrunnerWMC/ndspy) and install it
-manually.
+manually. Note that [crcmod](https://pypi.org/project/crcmod/) is a required
+dependency.
 
 
 Documentation

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -41,8 +41,7 @@ suitable for use in applications written in Python, and in scripts to do more
 complex tasks than the command-line tools are capable of.
 
 As ndspy is written in pure Python, it is cross-platform and should run on all
-platforms Python supports. Additionally, all dependencies other than Python
-itself are optional.
+platforms Python supports.
 
 Interested? Read on to see some examples, or check the :doc:`api` to see the
 documentation for a specific module. When you're ready to install, head over to
@@ -154,7 +153,8 @@ the following possibilities will probably work for you, though:
 If you want the very latest version of ndspy including features and bugfixes
 not yet in any official release, you can also download the code from the
 `GitHub repository <https://github.com/RoadrunnerWMC/ndspy>`_ and install it
-manually.
+manually. Note that `crcmod <https://pypi.org/project/crcmod/>`_ is a required
+dependency.
 
 
 Support

diff --git a/__init__.py → ndspy/__init__.py b/__init__.py → ndspy/__init__.py
diff --git a/_common.py → ndspy/_common.py b/_common.py → ndspy/_common.py
diff --git a/_lzCommon.py → ndspy/_lzCommon.py b/_lzCommon.py → ndspy/_lzCommon.py
diff --git a/bmg.py → ndspy/bmg.py b/bmg.py → ndspy/bmg.py
diff --git a/code.py → ndspy/code.py b/code.py → ndspy/code.py
diff --git a/codeCompression.py → ndspy/codeCompression.py b/codeCompression.py → ndspy/codeCompression.py
diff --git a/color.py → ndspy/color.py b/color.py → ndspy/color.py
diff --git a/extras/__init__.py → ndspy/extras/__init__.py b/extras/__init__.py → ndspy/extras/__init__.py
diff --git a/extras/music.py → ndspy/extras/music.py b/extras/music.py → ndspy/extras/music.py
diff --git a/extras/soundEffect.py → ndspy/extras/soundEffect.py b/extras/soundEffect.py → ndspy/extras/soundEffect.py
diff --git a/fnt.py → ndspy/fnt.py b/fnt.py → ndspy/fnt.py
diff --git a/graphics2D.py → ndspy/graphics2D.py b/graphics2D.py → ndspy/graphics2D.py
diff --git a/lz10.py → ndspy/lz10.py b/lz10.py → ndspy/lz10.py
diff --git a/model.py → ndspy/model.py b/model.py → ndspy/model.py
diff --git a/narc.py → ndspy/narc.py b/narc.py → ndspy/narc.py
diff --git a/rom.py → ndspy/rom.py b/rom.py → ndspy/rom.py
diff --git a/soundArchive.py → ndspy/soundArchive.py b/soundArchive.py → ndspy/soundArchive.py
diff --git a/soundBank.py → ndspy/soundBank.py b/soundBank.py → ndspy/soundBank.py
diff --git a/soundGroup.py → ndspy/soundGroup.py b/soundGroup.py → ndspy/soundGroup.py
diff --git a/soundSequence.py → ndspy/soundSequence.py b/soundSequence.py → ndspy/soundSequence.py
diff --git a/soundSequenceArchive.py → ndspy/soundSequenceArchive.py b/soundSequenceArchive.py → ndspy/soundSequenceArchive.py
diff --git a/soundSequencePlayer.py → ndspy/soundSequencePlayer.py b/soundSequencePlayer.py → ndspy/soundSequencePlayer.py
diff --git a/soundStream.py → ndspy/soundStream.py b/soundStream.py → ndspy/soundStream.py
diff --git a/soundStreamPlayer.py → ndspy/soundStreamPlayer.py b/soundStreamPlayer.py → ndspy/soundStreamPlayer.py
diff --git a/soundWave.py → ndspy/soundWave.py b/soundWave.py → ndspy/soundWave.py
diff --git a/soundWaveArchive.py → ndspy/soundWaveArchive.py b/soundWaveArchive.py → ndspy/soundWaveArchive.py
diff --git a/texture.py → ndspy/texture.py b/texture.py → ndspy/texture.py
diff --git a/setup.py b/setup.py
@@ -8,11 +8,14 @@
     version='1.0.0',
     author='RoadrunnerWMC',
     author_email='roadrunnerwmc@gmail.com',
-    description='ndspy is a Python library and suite of command-line tools that can help you read, modify and create many types of files used in Nintendo DS games.',
+    description='Python library that can help you read, modify and create many types of files used in Nintendo DS games.',
     long_description=long_description,
     long_description_content_type='text/markdown',
     url='https://github.com/RoadrunnerWMC/ndspy',
     packages=setuptools.find_packages(),
+    install_requires=[
+        'crcmod',
+    ],
     classifiers=[
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',