pynzb-0.1.0/0000755000076500000240000000000011201741122012147 5ustar ericflostaffpynzb-0.1.0/PKG-INFO0000644000076500000240000001223111201741122013243 0ustar ericflostaffMetadata-Version: 1.0 Name: pynzb Version: 0.1.0 Summary: pynzb is a unified API for parsing NZB files, with several concrete implementations included Home-page: http://github.com/ericflo/pynzb/tree/master Author: Eric Florenzano Author-email: floguy@gmail.com License: BSD Description: Introduction ------------ NZB is an XML-based file format for retrieving posts from NNTP (Usenet) servers. Since NZB is XML-based, it's relatively easy to build one-off parsers to parse NZB files. This project is an attempt to consolidate those many one-off NZB parsers into one simple interface. This package includes three implementations: one based on expat, another based on ElementTree, and a final implementation based on lxml. The order in which they were listed is in order of compatibility. The expat version should work on all versions of Python > 2.0, the lxml one will work on all versions > 2.5, and lxml will only work if you have lxml installed. A Note on Installing lxml ------------------------- While lxml is not a requirement, I have had a hard time installing lxml in the past. I have found this set of commands to work perfectly: .. sourcecode:: bash STATIC_DEPS=true easy_install 'lxml>=2.2beta4' STATIC_DEPS=true sudo easy_install 'lxml>=2.2beta4' API Documentation ----------------- Accessing the Default Parser ============================ Simply import nzb_parser from the pynzb package. It's an instantiated version of the fastest available parser that your system can support. Other Parser Locations ====================== ``ExpatNZBParser``: Available in the ``pynzb.expat_nzb`` namespace. ``ETreeNZBParser``: Available in the ``pynzb.etree_nzb`` namespace. ``LXMLNZBParser``: Available in the ``pynzb.lxml_nzb`` namespace. Using the NZB Parser ==================== If you're using a specific parser, like the ``ETreeNZBParser``, you will first have to instantiate it: .. sourcecode:: python nzb_parser = ETreeNZBParser() Otherwise, you can just import the default parser for your system: .. sourcecode:: python from pynzb import nzb_parser Then, simply call the ``parse`` method, giving it the xml string as the only argument: .. sourcecode:: python files = nzb_parser.parse('') This will return a list of ``NZBFiles`` for you to use. NZBFile Objects =============== All of the parsers return ``NZBFile`` objects, which are objects with the following properties: ``poster``: The name of the user who posted the file to the newsgroup. ``date``: A ``datetime.date`` representation of when the server first saw the file. ``subject``: The subject used when the user posted the file to the newsgroup. ``groups``: A list of strings representing the newsgroups in which this file may be found. ``segments``: A list of ``NZBSegment`` objects talking about where to get the contents of this file. NZBSegment Objects ================== Each ``NZBFile`` has a list of ``NZBSegment`` objects, which include information on how to retrieve a part of a file. Here's what you can find on an ``NZBSegment`` object: ``number``: The number of the segment in the list of files. ``bytes``: The size of the segment, in bytes. ``message_id``: The Message-ID of the segment (useful for retrieving the full contents) Example -------- In this example, we will grab an Ubuntu NZB and parse the file, printing out some information about each file and its segments. .. sourcecode:: python from pynzb import nzb_parser from urllib2 import urlopen # Grab a sample Ubuntu NZB ubuntu_nzb = urlopen('http://media.eflorenzano.com/misc/sample-ubuntu-nzb.nzb').read() # Parse the NZB into files files = nzb_parser.parse(ubuntu_nzb) # Print out each file's subject and the first two segment message ids for nzb_file in files: print nzb_file.subject for segment in nzb_file.segments[:2]: print ' ' + segment.message_id if len(nzb_file.segments) > 2: print ' ...' Keywords: nzb,parser,xml Platform: UNKNOWN Classifier: Programming Language :: Python Classifier: Topic :: Software Development :: Libraries :: Python Modules pynzb-0.1.0/pynzb/0000755000076500000240000000000011201741122013311 5ustar ericflostaffpynzb-0.1.0/pynzb/.___init__.py0000644000076500000240000000027211201734534015651 0ustar ericflostaffMac OS X  2ˆºATTR½¿º˜"˜"com.macromates.caret{ column = 8; line = 17; }pynzb-0.1.0/pynzb/__init__.py0000644000076500000240000000070511201734534015435 0ustar ericflostafffrom pynzb.expat_nzb import ExpatNZBParser try: from pynzb.etree_nzb import ETreeNZBParser except ImportError: ETreeNZBParser = None try: from pynzb.lxml_nzb import LXMLNZBParser except ImportError: LXMLNZBParser = None # Set up the parser based on speed precedence if LXMLNZBParser is not None: nzb_parser = LXMLNZBParser() elif ETreeNZBParser is not None: nzb_parser = ETreeNZBParser() else: nzb_parser = ExpatNZBParser()pynzb-0.1.0/pynzb/._base.py0000644000076500000240000000027311201737460015026 0ustar ericflostaffMac OS X  2‰»ATTR½Ã¯»˜#˜#com.macromates.caret{ column = 38; line = 78; }pynzb-0.1.0/pynzb/base.py0000644000076500000240000000511411201737460014610 0ustar ericflostaffimport datetime import time def parse_date(date): if isinstance(date, basestring): date = int(date) gmtime = time.gmtime(date) return datetime.date(gmtime.tm_year, gmtime.tm_mon, gmtime.tm_mday) class NZBSegment(object): def __init__(self, bytes, number, message_id=None): self.bytes = int(bytes) self.number = int(number) if message_id: self.message_id = message_id def set_message_id(self, message_id): self.message_id = message_id class NZBFile(object): def __init__(self, poster, date, subject, groups=None, segments=None): self.poster = poster self.date = parse_date(date) self.subject = subject self.groups = groups or [] self.segments = segments or [] def add_group(self, group): self.groups.append(group) def add_segment(self, segment): self.segments.append(segment) class BaseNZBParser(object): def parse(self, xml): raise NotImplementedError class BaseETreeNZBParser(BaseNZBParser): def get_etree_iter(self, xml, et=None): raise NotImplementedError def parse(self, xml): context = self.get_etree_iter(xml) files, current_file, current_segment = [], None, None for event, elem in context: if event == "start": # If it's an NZBFile, create an object so that we can add the # appropriate stuff to it. if elem.tag == "{http://www.newzbin.com/DTD/2003/nzb}file": current_file = NZBFile( poster = elem.attrib['poster'], date = elem.attrib['date'], subject = elem.attrib['subject'] ) elif event == "end": if elem.tag == "{http://www.newzbin.com/DTD/2003/nzb}file": files.append(current_file) elif elem.tag == "{http://www.newzbin.com/DTD/2003/nzb}group": current_file.add_group(elem.text) elif elem.tag == "{http://www.newzbin.com/DTD/2003/nzb}segment": current_file.add_segment( NZBSegment( bytes = elem.attrib['bytes'], number = elem.attrib['number'], message_id = elem.text ) ) # Clear the element, we don't need it any more. elem.clear() return filespynzb-0.1.0/pynzb/._etree_nzb.py0000644000076500000240000000027211201733303016060 0ustar ericflostaffMac OS X  2ˆºATTR½Æɺ˜"˜"com.macromates.caret{ column = 78; line = 8; }pynzb-0.1.0/pynzb/etree_nzb.py0000644000076500000240000000113711201733303015644 0ustar ericflostafffrom pynzb.base import BaseETreeNZBParser, NZBFile, NZBSegment try: import cElementTree as etree except ImportError: try: from xml.etree import ElementTree as etree except ImportError: raise ImportError("You must have either Python 2.5 or cElementTree " + "installed before you can use the etree NZB parser.") try: from cStringIO import StringIO except ImportError: from StringIO import StringIO class ETreeNZBParser(BaseETreeNZBParser): def get_etree_iter(self, xml, et=etree): return iter(et.iterparse(StringIO(xml), events=("start", "end")))pynzb-0.1.0/pynzb/._expat_nzb.py0000644000076500000240000000027311201737441016105 0ustar ericflostaffMac OS X  2‰»ATTR½ÆÄ»˜#˜#com.macromates.caret{ column = 43; line = 24; }pynzb-0.1.0/pynzb/expat_nzb.py0000644000076500000240000000240211201737441015664 0ustar ericflostafffrom xml.parsers import expat from pynzb.base import BaseNZBParser, NZBFile, NZBSegment class ExpatNZBParser(BaseNZBParser): def start_element(self, name, attrs): if name == 'file': self.current_file = NZBFile( poster = attrs['poster'], date = attrs['date'], subject = attrs['subject'] ) if name == 'segment': self.current_segment = NZBSegment( bytes = attrs['bytes'], number = attrs['number'] ) def end_element(self, name): if name == 'file': self.files.append(self.current_file) elif name == 'group': self.current_file.add_group(self.current_data) elif name == 'segment': self.current_segment.message_id(self.current_data) self.current_file.add_segment(self.current_segment) def char_data(self, data): self.current_data = data def parse(self, xml): self.files = [] parser = expat.ParserCreate() parser.StartElementHandler = self.start_element parser.EndElementHandler = self.end_element parser.CharacterDataHandler = self.char_data parser.Parse(xml) return self.filespynzb-0.1.0/pynzb/._lxml_nzb.py0000644000076500000240000000027311201733541015735 0ustar ericflostaffMac OS X  2‰»ATTR½Æ×»˜#˜#com.macromates.caret{ column = 19; line = 13; }pynzb-0.1.0/pynzb/lxml_nzb.py0000644000076500000240000000073611201733541015524 0ustar ericflostafffrom pynzb.base import BaseETreeNZBParser, NZBFile, NZBSegment try: from lxml import etree except ImportError: raise ImportError("You must have lxml installed before you can use the " + "lxml NZB parser.") try: from cStringIO import StringIO except ImportError: from StringIO import StringIO class LXMLNZBParser(BaseETreeNZBParser): def get_etree_iter(self, xml, et=etree): return iter(et.iterparse(StringIO(xml), events=("start", "end")))pynzb-0.1.0/pynzb/._tests.py0000644000076500000240000000027111201737503015252 0ustar ericflostaffMac OS X  2‡¹ATTR½Î㹘!˜!com.macromates.caretxœ«æR‚äüœÒÜ<[cSk°@Nf^*”[ œCpynzb-0.1.0/pynzb/tests.py0000644000076500000240000000371411201737503015042 0ustar ericflostaffimport datetime import time from pynzb.base import BaseNZBParser, parse_date from pynzb import ExpatNZBParser, ETreeNZBParser, LXMLNZBParser SAMPLE_NZB = """ alt.binaries.newzbin alt.binaries.mojo 123456789abcdef@news.newzbin.com 987654321fedbca@news.newzbin.com """ def test_parse_date(): parser = BaseNZBParser() date = parse_date("1071674882") assert date == datetime.date(2003, 12, 17) def assert_sample_nzb(f): assert f.poster == 'Joe Bloggs (bloggs@nowhere.example)' assert f.date == parse_date(1071674882) assert f.subject == "Here's your file! abc-mr2a.r01 (1/2)" assert sorted(f.groups) == sorted(['alt.binaries.newzbin', 'alt.binaries.mojo']) first_segment = sorted(f.segments, key=lambda s: s.number)[0] assert first_segment.bytes == 102394 assert first_segment.number == 1 assert first_segment.message_id == '123456789abcdef@news.newzbin.com' second_segment = sorted(f.segments, key=lambda s: s.number)[1] assert second_segment.bytes == 4501 assert second_segment.number == 2 assert second_segment.message_id == '987654321fedbca@news.newzbin.com' def test_expat(): parser = ExpatNZBParser() files = parser.parse(SAMPLE_NZB) assert_sample_nzb(files[0]) def test_etree(): parser = ETreeNZBParser() files = parser.parse(SAMPLE_NZB) assert_sample_nzb(files[0]) def test_lxml(): parser = LXMLNZBParser() files = parser.parse(SAMPLE_NZB) assert_sample_nzb(files[0])pynzb-0.1.0/pynzb.egg-info/0000755000076500000240000000000011201741122015003 5ustar ericflostaffpynzb-0.1.0/pynzb.egg-info/dependency_links.txt0000644000076500000240000000000111201741122021051 0ustar ericflostaff pynzb-0.1.0/pynzb.egg-info/not-zip-safe0000644000076500000240000000000111201741113017231 0ustar ericflostaff pynzb-0.1.0/pynzb.egg-info/PKG-INFO0000644000076500000240000001223111201741122016077 0ustar ericflostaffMetadata-Version: 1.0 Name: pynzb Version: 0.1.0 Summary: pynzb is a unified API for parsing NZB files, with several concrete implementations included Home-page: http://github.com/ericflo/pynzb/tree/master Author: Eric Florenzano Author-email: floguy@gmail.com License: BSD Description: Introduction ------------ NZB is an XML-based file format for retrieving posts from NNTP (Usenet) servers. Since NZB is XML-based, it's relatively easy to build one-off parsers to parse NZB files. This project is an attempt to consolidate those many one-off NZB parsers into one simple interface. This package includes three implementations: one based on expat, another based on ElementTree, and a final implementation based on lxml. The order in which they were listed is in order of compatibility. The expat version should work on all versions of Python > 2.0, the lxml one will work on all versions > 2.5, and lxml will only work if you have lxml installed. A Note on Installing lxml ------------------------- While lxml is not a requirement, I have had a hard time installing lxml in the past. I have found this set of commands to work perfectly: .. sourcecode:: bash STATIC_DEPS=true easy_install 'lxml>=2.2beta4' STATIC_DEPS=true sudo easy_install 'lxml>=2.2beta4' API Documentation ----------------- Accessing the Default Parser ============================ Simply import nzb_parser from the pynzb package. It's an instantiated version of the fastest available parser that your system can support. Other Parser Locations ====================== ``ExpatNZBParser``: Available in the ``pynzb.expat_nzb`` namespace. ``ETreeNZBParser``: Available in the ``pynzb.etree_nzb`` namespace. ``LXMLNZBParser``: Available in the ``pynzb.lxml_nzb`` namespace. Using the NZB Parser ==================== If you're using a specific parser, like the ``ETreeNZBParser``, you will first have to instantiate it: .. sourcecode:: python nzb_parser = ETreeNZBParser() Otherwise, you can just import the default parser for your system: .. sourcecode:: python from pynzb import nzb_parser Then, simply call the ``parse`` method, giving it the xml string as the only argument: .. sourcecode:: python files = nzb_parser.parse('') This will return a list of ``NZBFiles`` for you to use. NZBFile Objects =============== All of the parsers return ``NZBFile`` objects, which are objects with the following properties: ``poster``: The name of the user who posted the file to the newsgroup. ``date``: A ``datetime.date`` representation of when the server first saw the file. ``subject``: The subject used when the user posted the file to the newsgroup. ``groups``: A list of strings representing the newsgroups in which this file may be found. ``segments``: A list of ``NZBSegment`` objects talking about where to get the contents of this file. NZBSegment Objects ================== Each ``NZBFile`` has a list of ``NZBSegment`` objects, which include information on how to retrieve a part of a file. Here's what you can find on an ``NZBSegment`` object: ``number``: The number of the segment in the list of files. ``bytes``: The size of the segment, in bytes. ``message_id``: The Message-ID of the segment (useful for retrieving the full contents) Example -------- In this example, we will grab an Ubuntu NZB and parse the file, printing out some information about each file and its segments. .. sourcecode:: python from pynzb import nzb_parser from urllib2 import urlopen # Grab a sample Ubuntu NZB ubuntu_nzb = urlopen('http://media.eflorenzano.com/misc/sample-ubuntu-nzb.nzb').read() # Parse the NZB into files files = nzb_parser.parse(ubuntu_nzb) # Print out each file's subject and the first two segment message ids for nzb_file in files: print nzb_file.subject for segment in nzb_file.segments[:2]: print ' ' + segment.message_id if len(nzb_file.segments) > 2: print ' ...' Keywords: nzb,parser,xml Platform: UNKNOWN Classifier: Programming Language :: Python Classifier: Topic :: Software Development :: Libraries :: Python Modules pynzb-0.1.0/pynzb.egg-info/requires.txt0000644000076500000240000000001211201741122017374 0ustar ericflostaffsetuptoolspynzb-0.1.0/pynzb.egg-info/SOURCES.txt0000644000076500000240000000043311201741122016667 0ustar ericflostaffsetup.py pynzb/__init__.py pynzb/base.py pynzb/etree_nzb.py pynzb/expat_nzb.py pynzb/lxml_nzb.py pynzb/tests.py pynzb.egg-info/PKG-INFO pynzb.egg-info/SOURCES.txt pynzb.egg-info/dependency_links.txt pynzb.egg-info/not-zip-safe pynzb.egg-info/requires.txt pynzb.egg-info/top_level.txtpynzb-0.1.0/pynzb.egg-info/top_level.txt0000644000076500000240000000000611201741122017531 0ustar ericflostaffpynzb pynzb-0.1.0/setup.cfg0000644000076500000240000000007311201741122013770 0ustar ericflostaff[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 pynzb-0.1.0/._setup.py0000644000076500000240000000027411201740712014105 0ustar ericflostaffMac OS X  2Š¼ATTR¾w¼˜$˜$com.macromates.caret{ column = 17; line = 155; }pynzb-0.1.0/setup.py0000644000076500000240000001066011201740712013670 0ustar ericflostafffrom setuptools import setup, find_packages version = '0.1.0' LONG_DESCRIPTION = """ Introduction ------------ NZB is an XML-based file format for retrieving posts from NNTP (Usenet) servers. Since NZB is XML-based, it's relatively easy to build one-off parsers to parse NZB files. This project is an attempt to consolidate those many one-off NZB parsers into one simple interface. This package includes three implementations: one based on expat, another based on ElementTree, and a final implementation based on lxml. The order in which they were listed is in order of compatibility. The expat version should work on all versions of Python > 2.0, the lxml one will work on all versions > 2.5, and lxml will only work if you have lxml installed. A Note on Installing lxml ------------------------- While lxml is not a requirement, I have had a hard time installing lxml in the past. I have found this set of commands to work perfectly: .. sourcecode:: bash STATIC_DEPS=true easy_install 'lxml>=2.2beta4' STATIC_DEPS=true sudo easy_install 'lxml>=2.2beta4' API Documentation ----------------- Accessing the Default Parser ============================ Simply import nzb_parser from the pynzb package. It's an instantiated version of the fastest available parser that your system can support. Other Parser Locations ====================== ``ExpatNZBParser``: Available in the ``pynzb.expat_nzb`` namespace. ``ETreeNZBParser``: Available in the ``pynzb.etree_nzb`` namespace. ``LXMLNZBParser``: Available in the ``pynzb.lxml_nzb`` namespace. Using the NZB Parser ==================== If you're using a specific parser, like the ``ETreeNZBParser``, you will first have to instantiate it: .. sourcecode:: python nzb_parser = ETreeNZBParser() Otherwise, you can just import the default parser for your system: .. sourcecode:: python from pynzb import nzb_parser Then, simply call the ``parse`` method, giving it the xml string as the only argument: .. sourcecode:: python files = nzb_parser.parse('') This will return a list of ``NZBFiles`` for you to use. NZBFile Objects =============== All of the parsers return ``NZBFile`` objects, which are objects with the following properties: ``poster``: The name of the user who posted the file to the newsgroup. ``date``: A ``datetime.date`` representation of when the server first saw the file. ``subject``: The subject used when the user posted the file to the newsgroup. ``groups``: A list of strings representing the newsgroups in which this file may be found. ``segments``: A list of ``NZBSegment`` objects talking about where to get the contents of this file. NZBSegment Objects ================== Each ``NZBFile`` has a list of ``NZBSegment`` objects, which include information on how to retrieve a part of a file. Here's what you can find on an ``NZBSegment`` object: ``number``: The number of the segment in the list of files. ``bytes``: The size of the segment, in bytes. ``message_id``: The Message-ID of the segment (useful for retrieving the full contents) Example -------- In this example, we will grab an Ubuntu NZB and parse the file, printing out some information about each file and its segments. .. sourcecode:: python from pynzb import nzb_parser from urllib2 import urlopen # Grab a sample Ubuntu NZB ubuntu_nzb = urlopen('http://media.eflorenzano.com/misc/sample-ubuntu-nzb.nzb').read() # Parse the NZB into files files = nzb_parser.parse(ubuntu_nzb) # Print out each file's subject and the first two segment message ids for nzb_file in files: print nzb_file.subject for segment in nzb_file.segments[:2]: print ' ' + segment.message_id if len(nzb_file.segments) > 2: print ' ...' """ setup( name='pynzb', version=version, description="pynzb is a unified API for parsing NZB files, with several concrete implementations included", long_description=LONG_DESCRIPTION, classifiers=[ "Programming Language :: Python", "Topic :: Software Development :: Libraries :: Python Modules", ], keywords='nzb,parser,xml', author='Eric Florenzano', author_email='floguy@gmail.com', url='http://github.com/ericflo/pynzb/tree/master', license='BSD', packages=find_packages(), include_package_data=True, zip_safe=False, install_requires=['setuptools'], )