Skip to content

Commit b3ca89f

Browse files
author
Michel Alexandre Salim
committed
Version 0.1.0
- convert documentation to reStructuredText format for PyPI - move tests to within the module they are testing - setup.py: - read long_description and version from files - add download URL - also package AUTHORS and TODO - re-add license declaration for completeness
1 parent 604ceb0 commit b3ca89f

10 files changed

+40
-13
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
21
# compiled Python files
32
*.py?
3+
4+
# generated by setup.py
45
build
6+
dist
7+
MANIFEST
58

69
# temporary files
710
*~

AUTHORS.md AUTHORS.rst

File renamed without changes.

README

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
README.rst

README.md README.rst

+14-6
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,29 @@ Prelude library for Python
22
==========================
33
This library provides functional programming constructs from languages
44
such as Haskell and Scala, implemented using existing Python libraries
5-
such as `abc` (_abstract base class_) as appropriate.
5+
such as ``abc`` (*abstract base class*) as appropriate.
66

7-
The intention is for this to complement the existing `functools` library,
7+
The intention is for this to complement the existing ``functools`` library,
88
not to replace it.
99

10+
1011
Installation
1112
------------
12-
This package will be posted on PyPI once it's ready
13+
From an unpacked archive::
14+
15+
$ python setup.py install
16+
17+
With `pip <http://pypi.python.org/pypi/pip>`_::
18+
19+
$ pip install prelude
20+
1321

1422
License
1523
-------
1624
Copyright © 2012 Michel Alexandre Salim. Distributed under the MIT
17-
license. See the file `LICENSE`. For a humorous
18-
[poetic](https://github.com/alexgenaud/Poetic-License/blob/master/README)
19-
"translation" of the terms, read on:
25+
license. See the file ``LICENSE``. For a humorous
26+
`poetic <https://github.com/alexgenaud/Poetic-License/blob/master/README>`_
27+
"translation" of the terms, read on::
2028

2129
This work ‘as-is’ we provide.
2230
No warranty express or implied.

TODO.md TODO.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Code
66
* more monads
77
* singly-linked lists
88
* list/sequence functions
9-
...
9+
* ...
1010

1111

1212
Packaging
1313
---------
14-
* add 'test' target to setup.py
14+
* add ``test`` target to setup.py

prelude/__init__.py

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
__all__ = [
44
"typeclasses",
55
]
6+
7+
__version__ = '0.1.0'
File renamed without changes.
File renamed without changes.
File renamed without changes.

setup.py

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
from distutils.core import setup
2+
from prelude import __version__
3+
import os
24

3-
setup(name='Prelude',
4-
version='0.1.0',
5-
description='Prelude library of functional programming constructs',
5+
URL='https://github.com/hircus/python-prelude'
6+
7+
def read(fname):
8+
return open(os.path.join(os.path.dirname(__file__), fname)).read()
9+
10+
setup(name='prelude',
11+
version=__version__,
612
author='Michel Alexandre Salim',
713
author_email='[email protected]',
8-
url='http://github.com/msylvestre/prelude',
14+
url=URL,
15+
download_url=('%s/zipball/%s' % (URL, __version__)),
16+
description='Prelude library of functional programming constructs',
17+
license='MIT',
18+
long_description=read('README.rst'),
919
packages=['prelude'],
20+
data_files=[('.', ['LICENSE', 'AUTHORS.rst', 'TODO.rst']),
21+
],
22+
install_requires=[],
1023
classifiers = [
1124
'Development Status :: 3 - Alpha',
1225
'Intended Audience :: Developers',

0 commit comments

Comments
 (0)