Browse Source

setup.py: added metadata for pypi.org; readme markdown->rest

Fabian Peter Hammerle 4 years ago
parent
commit
1475df2011
4 changed files with 41 additions and 21 deletions
  1. 7 0
      CHANGELOG.md
  2. 0 21
      README.md
  3. 24 0
      README.rst
  4. 10 0
      setup.py

+ 7 - 0
CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## unreleased
+
+### Added
+- Prepare push to pypi.org
+  - Converted readme from markdown to ReSructuredText format
+  - Added module metadata (author, maintainer, url)
+
 ## [1.0.0] 2019-09-03
 
 ### Added

+ 0 - 21
README.md

@@ -1,21 +0,0 @@
-# python-dlinfo
-
-Python wrapper for libc's dlinfo
-
-# install
-
-```sh
-pip install dlinfo
-# or
-pipenv install dlinfo
-```
-
-# usage
-
-```python
->>> from dlinfo import DLInfo
->>> lib = ctypes.cdll.LoadLibrary(ctypes.util.find_library('c'))
->>> dlinfo = DLInfo(lib)
->>> dlinfo.path
-'/lib/x86_64-linux-gnu/libc.so.6'
-```

+ 24 - 0
README.rst

@@ -0,0 +1,24 @@
+python-dlinfo
+=============
+
+Python wrapper for libc's dlinfo
+
+Install
+-------
+
+```sh
+pip install dlinfo
+# or
+pipenv install dlinfo
+```
+
+Usage
+-----
+
+.. code:: python
+
+   >>> from dlinfo import DLInfo
+   >>> lib = ctypes.cdll.LoadLibrary(ctypes.util.find_library('c'))
+   >>> dlinfo = DLInfo(lib)
+   >>> dlinfo.path
+   '/lib/x86_64-linux-gnu/libc.so.6'

+ 10 - 0
setup.py

@@ -1,8 +1,18 @@
 import setuptools
 
+with open('README.rst', 'r') as readme:
+    LONG_DESCRIPTION = readme.read()
+
 setuptools.setup(
     name='dlinfo',
     use_scm_version=True,
+    author='Fabian Peter Hammerle',
+    author_email='fabianpeter.hammerle@catalysts.cc',
+    maintainer='Catalysts Space',
+    maintainer_email='space@catalysts.cc',
+    description='Python wrapper for libc\'s dlinfo',
+    long_description=LONG_DESCRIPTION,
+    url='https://code.grasp-open.com/grasp-tools/python-dlinfo',
     packages=setuptools.find_packages(),
     setup_requires=[
         'setuptools_scm',