README (3469B)
1 gnunetbib 2 --------- 3 4 Code based on anonbib, original README included below. 5 6 The purpose of gnunetbib is similar to anonbib for torproject: 7 We need an trustable deployment for our bibliography and 8 reference papers without relying on external sources. 9 10 Right now this is based on anonbib's code, which in turn was 11 based on PDOSBib code. anonbib is python2.7 code. Over the 12 course of usage we will have to change this. The codebase 13 diverges from anonbib where necessary (examples include: 14 easier to read and understand python code, gnunet specific 15 parts,...). 16 17 Like anonbib this software is licensed under the GNU GPL, 18 version 2 or later. 19 20 gnunetbib is Copyright (C) 2017, 2018, 2019 ng0 <ng0@n0.is>. 21 Other contributors are expected to either add themselves 22 here or in AUTHORS. 23 24 NOTE: 25 ----- 26 27 Due to technical reasons I am currently looking into an 28 improved version from scratch. Well tested tools with 29 decades of real-life usage exist which are far better 30 suited than code base this started from. 31 32 (I ported the existing code to python3 -schanzen) 33 34 HACKING 35 ------- 36 37 guix environment --ad-hoc python@2.7 python2-pylint python2-future 38 39 Follow python coding standards for new code! 40 41 42 Original README 43 --------------- 44 anonbib 0.3 -- Code to generate the anonymity bibliography 45 46 Copyright (c) 2003-2008 Nick Mathewson 47 Based on 'PDOSBib' perl code by Eddie Kohler 48 49 This software is licensed under the GNU GPL, version 2 or later. 50 51 To use this software, you need to understand BibTeX and Python a 52 little. If it breaks, you get to keep both pieces. You will need 53 Python 2.2 or later. 54 55 To use this package: 56 - Get a good BibTeX file. You may want to mark it up with some of the 57 extra keys used in our "anonbib.bib" file. All of the additional 58 Bibtex keys we use have the prefix "www_"; check out anonbib.bib 59 for their usage. 60 61 - Edit anonbib.cfg and _template_.html and _template_bibtex.html so they 62 refer to your files, authors, topics, and so on. 63 64 - Run 'python updateCache.py anonbib.cfg' to create a local cache of the 65 papers in your bibliography based on their www_*_url entries. (By 66 default, the script will ignore any entries you have already cached. To 67 force a fresh download of a cached file, delete it.) 68 69 - Run 'python rank.py anonbib.cfg' to download Google Scholar rankings of 70 all the papers. 71 72 - Run 'python writeHTML.py anonbib.cfg'. Fix any errors you care about. 73 74 - Re-run these scripts when you change the bibliography. 75 76 - If you want to merge in big BibTeX files, try using the reconcile.py 77 script. See the comment at the start of the file for usage info. 78 79 80 New in 0.3: 81 - Support for Google Scholar rankings to denote hot/rising papers. 82 Implemented by George Danezis. 83 - Make reconcile script generate more useful output. 84 - Add support for multiple bibliographies generated from a single bibtex 85 source. This is done via 'tags' on bibtex entries. If an entry is 86 tagged, it appears in the corresponding bibliographies. This is good 87 for generating a master bibliography and one or more selected readings 88 lists from the same source. 89 - Handle more errors when downloading files. 90 - When fetching a paper with a .ps url, generate the .ps.gz file 91 automatically. 92 - Note an error when a crossref overrides an existing field in an entry. 93 - Handle the Proceedings type correctly. 94 - Enforce proper encoding on pages: it must be number--number. 95 -