Skip to content
Browse files

updated docs; updated setup.py for PyPI inclusion; added MANIFEST.in …

…template;
  • Loading branch information...
1 parent d2ccadc commit 31251e85d96adf0eeb35bf8129eacb49f513016d Russel Porosky committed
Showing with 47 additions and 8 deletions.
  1. +3 −1 .gitignore
  2. +1 −0 MANIFEST.in
  3. +5 −3 ReadMe.md
  4. +38 −4 setup.py
View
4 .gitignore
@@ -1,2 +1,4 @@
nbproject/
-build/
+build/
+dist/
+MANIFEST
View
1 MANIFEST.in
@@ -0,0 +1 @@
+include *.c *.h *.txt *.md *.cfg *.py
View
8 ReadMe.md
@@ -30,7 +30,7 @@
**`stop()`** - returns an `int` referencing the current time stamp.
-**`diff(int A, int B)`** - returns the difference between two timestamp references provided by `start()`, `checkpoint()` or `get()`. Order does not matter, result is always a positive `float` representing seconds.
+**`diff(int A, int B)`** - returns the difference between two timestamp references provided by `start()`, `checkpoint()` or `stop()`. Order does not matter, result is always a positive `float` representing seconds.
**`get()`** - returns the number of seconds as a `float` since the `cTimer` library was `import`ed.
@@ -45,6 +45,8 @@ Clone the repository into a new folder. Run the following commands (you *may* ne
This is a lightweight extension and has not been thouroughly tested on all combinations of platforms and Python versions.
-It has been tested on CentOS 5, Ubuntu 10.4, and OSX 10.5 to 10.7 using Python 2.7. All platforms were 64-bit.
+It has been tested on CentOS 5, Ubuntu 10.4, and OSX 10.5 to 10.8 using Python 2.7 and Python 3.2. All platforms were 64-bit.
-This *should* work on Windows and with 32-bit hosts, but that has not been tested yet.
+This *should* work with 32-bit hosts, but that has not been tested yet.
+
+This *does not* work on Windows hosts yet.
View
42 setup.py
@@ -1,8 +1,14 @@
#!/usr/bin/env python
+"""
+cTimer: A high resolution, high precision timer.
+"""
+
+import os
import sys
+
from distutils.core import setup, Extension
-if sys.platform == "darwin":
+if sys.platform == 'darwin':
module1 = Extension('cTimer',
sources = ['cTimer.c'])
else:
@@ -10,10 +16,38 @@
sources = ['cTimer.c'],
extra_link_args = ['-lrt'])
-setup (name = 'cTimer',
- version = '0.1',
+f = open(os.path.join(os.path.dirname(__file__), 'ReadMe.md'))
+long_description = f.read()
+f.close()
+version = '0.1.1'
+
+setup (
+ name = 'cTimer',
+ version = version,
description = 'A high precision timer.',
+ long_description = long_description,
author = 'Chaordix (Russ Porosky)',
author_email = 'russ@chaordix.com',
url = 'https://github.com/chaordix/cTimer/',
- ext_modules = [module1])
+ download_url = ('https://github.com/downloads/Chaordix/cTimer/cTimer-%s.tar.gz' % version),
+ maintainer = 'Chaordix (Russ Porosky)',
+ maintainer_email = 'russ@chaordix.com',
+ keywords = ['timer', 'precision'],
+ license = 'MIT',
+ platforms = 'ALL',
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Console',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: MIT License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Programming Language :: Python :: 2.5',
+ 'Programming Language :: Python :: 2.6',
+ 'Programming Language :: Python :: 2.7',
+ 'Programming Language :: Python :: 3',
+ 'Programming Language :: Python :: 3.2',
+ 'Programming Language :: Python :: 3.3',
+ ],
+ ext_modules = [module1]
+)

0 comments on commit 31251e8

Please sign in to comment.
Something went wrong with that request. Please try again.