search

diffpy / pyobjcryst

Python bindings to ObjCryst++ Object-Oriented Crystallographic Library
Other
15 stars 17 forks source link

TODO List #1

Closed XiaohaoYang closed 10 years ago

XiaohaoYang commented 10 years ago
  1. update INSTALL.txt with correct instructions and dependencies (boost version >1.46?)
  2. update LICENSE.txt (if a different license is required by BNL/Columbia)
  3. update README.txt with more information
  4. clean TODO.txt
  5. update setup.py, add header, update url and author information(?)
  6. update the headers of all .py files
  7. add headers to scons scripts(?)
  8. update MANIFEST.in and setup.py, include install.txt(?),libobjcryst(?), doc(?) directories.
  9. remove devutils directory(?)
pavoljuhas commented 10 years ago

Perhaps this is too many items for a single ticket.

(1) pyobjcryst builds fine with old boost, it does not use serialization

(4) Check with Chris if TODO is uptodate, it should be otherwise converted to issues.

(6) I would leave the standard header as is in all files that already have it. It basically marks at what point was each source file started (however, new files should refer to BNL-CMI initiative as in __init__.py. (If the BNL IP people ask us to change headers we'll do it then)

(7) We don't need license reference in scons files. If you want to add some user info about supported targets and options, this can go to SConstruct.

(8) libObjCryst should not be included, eventually we should convert it to a standalone project like libdiffpy if Vincent agrees. doc should not be included, because manual is not ready. For now the easiest would be to include libObjCryst tarball as a separate file with pyobjcryst GitHub release.

(9) devutils should eventually go, but for now let's just exclude them from MANIFEST.in.

XiaohaoYang commented 10 years ago

Converted to separate tickets and I think we can close it