From 38029c52b7ac7842d71e2001d3e82528ae28de8b Mon Sep 17 00:00:00 2001 From: Alan Grow Date: Sun, 11 Jun 2017 12:22:30 -0600 Subject: [PATCH 1/3] convert README to github markdown. --- MANIFEST | 2 +- README | 68 ------------------------------------------------------- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- 4 files changed, 61 insertions(+), 70 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/MANIFEST b/MANIFEST index 18cf95c..5087e97 100644 --- a/MANIFEST +++ b/MANIFEST @@ -1,7 +1,7 @@ MANIFEST ChangeLog Example -README +README.md COPYING setup.py setup.cfg diff --git a/README b/README deleted file mode 100644 index 80d4101..0000000 --- a/README +++ /dev/null @@ -1,68 +0,0 @@ -python-cdb 0.35 -Alan Grow -15 Feb 2013 - -INTRO -===== -The python-cdb extension module is an adaptation of D. J. Bernstein's -constant database package (see http://cr.yp.to/cdb.html). - -cdb files are mappings of keys to values, designed for wickedly -fast lookups and atomic updates. This module mimics the normal -cdb utilities, cdb(get|dump|make), via convenient, high-level Python -objects. - - -COPYRIGHT -========= -python-cdb is free software, as is cdb itself. - -The extension module is licensed under the GNU GPL version 2 or later, -and is copyright 2001, 2002 Michael J. Pomraning. Ancillary files from -Felix von Leitner's libowfat are also licensed under the GPL. Finally, -modifications to D. J. Bernstein's public domain cdb implementation are -similarly released to the public domain. - - -INSTALL -======= - - $ tar zxf python-cdb-$VERSION.tgz - $ cd python-cdb-$VERSION - $ python setup.py build - $ python setup.py install - # python setup.py bdist --format=rpm, if you prefer - -Now break it and tell me about it (or use it smoothly and tell me -about that, too). - -DOCS -==== -Consult the docstrings for module, class, and function documentation. - - $ python -c 'import cdb; print cdb.__doc__' - $ python -c 'import cdb; print cdb.cdbmake("f.cdb","f.tmp").__doc__' - $ python -c 'import cdb; print cdb.init("some.cdb").__doc__' - -BUGS -==== -Bug reports to Alan Grow . - - -TODO -==== - - - more dict-like API - - - test cases - - - take advantage of contemporary Python API - - - formal speed benchmarks - - - possibly revert to DJB's cdb implementation - explicitly public domain since 2007Q4 - - - better README/docs - - - mingw support diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2dcf91 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +## INTRO + +The `python-cdb` extension module is an adaptation of D. J. Bernstein's [constant database package](http://cr.yp.to/cdb.html). + +`cdb` files are mappings of keys to values, designed for wickedly fast lookups and atomic updates. This module mimics the normal `cdb` utilities, `cdb(get|dump|make)`, via convenient, high-level Python objects. + + +## INSTALL + +```sh +tar zxf python-cdb-$VERSION.tgz +cd python-cdb-$VERSION +python setup.py build +python setup.py install +# python setup.py bdist --format=rpm, if you prefer +``` + +Now break it and tell me about it (or use it smoothly and tell me about that, too). + + +## DOCS + +Consult the docstrings for module, class, and function documentation. + +```sh +python -c 'import cdb; print cdb.__doc__' +python -c 'import cdb; print cdb.cdbmake("f.cdb","f.tmp").__doc__' +python -c 'import cdb; print cdb.init("some.cdb").__doc__' +``` + + +## BUGS + +Please report new bugs via the [Github issue tracker](https://github.com/acg/python-cdb/issues). + + +## TODO + +- [ ] more dict-like API +- [ ] test cases +- [ ] take advantage of contemporary Python API +- [ ] formal speed benchmarks +- [ ] possibly revert to DJB's cdb implementation; explicitly public domain since 2007Q4 +- [ ] better README/docs +- [ ] mingw support + + +## COPYRIGHT + +`python-cdb` is free software, as is cdb itself. + +The extension module is licensed under the GNU GPL version 2 or later, and is copyright 2001, 2002 Michael J. Pomraning. Ancillary files from Felix von Leitner's libowfat are also licensed under the GPL. Finally, modifications to D. J. Bernstein's public domain cdb implementation are similarly released to the public domain. + + +## AUTHORS + +- Alan Grow +- Mike Pomraning + diff --git a/setup.cfg b/setup.cfg index 5f9c528..31cfd86 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,6 +3,6 @@ [bdist_rpm] release = 1 doc_files = ChangeLog - README + README.md COPYING Example From 8c70e21bd0552ff79bd9b5e67f61d16b66eb0d43 Mon Sep 17 00:00:00 2001 From: nickjacobson Date: Fri, 17 Jun 2016 13:55:31 -0700 Subject: [PATCH 2/3] Adding trove classifiers. Adding trove classifiers. --- setup.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 27c113f..a7e6de2 100644 --- a/setup.py +++ b/setup.py @@ -30,5 +30,8 @@ ) ], url = "https://github.com/acg/python-cdb", + classifiers=[ + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + ], ) - From c0bad075a04a719f31e6387260b0730c3243fcb1 Mon Sep 17 00:00:00 2001 From: Pavi Subenderan Date: Mon, 3 Apr 2017 16:06:09 -0700 Subject: [PATCH 3/3] cdb now successfully imports on both pypy and cpython --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index a7e6de2..5b3320d 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ cdb utilities, cdb(get|dump|make), via convenient, high-level Python objects.''', ext_modules = [ Extension( - "cdbmodule", + "cdb", SRCFILES, include_dirs=[ SRCDIR + '/' ], extra_compile_args=['-fPIC'],