Add READMEs for all the packages.

habnabit · Dec 22, 2016 · c751866 · c751866
1 parent c0d12f2
commit c751866
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 14 deletions.
diff --git a/passacre-backend/CMakeLists.txt b/passacre-backend/CMakeLists.txt
@@ -92,10 +92,10 @@ add_custom_command(OUTPUT "${CMAKE_BINARY_DIR}/${PASSACRE_BACKEND}"
                    DEPENDS cargo-passacre "${CARGO_BUILD_DIR}/passacre-backend"
                    COMMAND ${CMAKE_COMMAND} -E
                            copy "${CARGO_BUILD_DIR}/passacre-backend" "${CMAKE_BINARY_DIR}/${PASSACRE_BACKEND}")
-add_custom_command(OUTPUT "${CMAKE_BINARY_DIR}/setup.py"
-                   DEPENDS setup.py
-                   COMMAND ${CMAKE_COMMAND} -E
-                           copy "${CMAKE_SOURCE_DIR}/setup.py" "${CMAKE_BINARY_DIR}/setup.py")
+add_custom_command(OUTPUT "${CMAKE_BINARY_DIR}/setup.py" "${CMAKE_BINARY_DIR}/README.rst"
+                   DEPENDS setup.py README.rst
+                   COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_SOURCE_DIR}/setup.py" "${CMAKE_BINARY_DIR}/setup.py"
+                   COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_SOURCE_DIR}/README.rst" "${CMAKE_BINARY_DIR}/README.rst")
 add_custom_target(passacre-backend-wheel ALL
                   COMMAND env "PASSACRE_VERSION=${VERSION}" pip wheel .
                   DEPENDS "${CMAKE_BINARY_DIR}/${PASSACRE_BACKEND}" "${CMAKE_BINARY_DIR}/setup.py"

diff --git a/passacre-backend/README.rst b/passacre-backend/README.rst
@@ -0,0 +1,12 @@
+================
+passacre-backend
+================
+
+The backend that does all the work for `passacre`_.
+This is a native binary containing no python code.
+It's a lot of `Rust`_,
+which currently is difficult to compile.
+
+
+.. _passacre: https://github.com/habnabit/passacre
+.. _Rust: https://www.rust-lang.org/
diff --git a/passacre-backend/setup.py b/passacre-backend/setup.py
@@ -9,6 +9,8 @@
 
 
 backend = 'passacre-backend-{0}-{4}'.format(*os.uname())
+with open('README.rst', 'r') as infile:
+    long_description = infile.read()
 
 
 try:
@@ -39,7 +41,7 @@ def get_tag(self):
 setup(
     name='passacre-backend',
     description='better repeatable password generation',
-    long_description='',
+    long_description=long_description,
     author='Aaron Gallagher',
     author_email='_@habnab.it',
     url='https://github.com/habnabit/passacre',

diff --git a/passacre-metapackage/README.rst b/passacre-metapackage/README.rst
@@ -0,0 +1,11 @@
+========
+passacre
+========
+
+A `passacre`_ metapackage,
+which depends on the same version of `passacre-backend`_ and `passacre-nobackend`_.
+Otherwise it's hard to publish the two separately.
+
+.. _passacre: https://github.com/habnabit/passacre
+.. _passacre-backend: https://pypi.python.org/pypi/passacre-backend
+.. _passacre-nobackend: https://pypi.python.org/pypi/passacre-nobackend
diff --git a/passacre-metapackage/setup.py b/passacre-metapackage/setup.py
@@ -7,8 +7,8 @@
 
 
 version = versioneer.get_version()
-#with open('../README.rst', 'r') as infile:
-long_description = ''#infile.read()
+with open('README.rst', 'r') as infile:
+    long_description = infile.read()
 
 
 setup(
@@ -24,13 +24,6 @@
         'Intended Audience :: End Users/Desktop',
         'License :: OSI Approved :: ISC License (ISCL)',
         'Operating System :: OS Independent',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Topic :: Security',
     ],
     license='ISC',