pyfec: rename pyfec to zfec

It turns out that "pyfec" turns off people who aren't Python hackers.
"allmyfec" is too long for a low-level core utility library.
"fec" is too generic (it is already used by Luigi Rizzo's library which this
library is based on, for one thing).

I'm open to other naming suggestions, especially before we widely announce this
library, which I expect will happen within a few days.
This commit is contained in:
Zooko O'Whielacronx 2007-04-18 09:19:00 -07:00
parent c2dfcb1f01
commit acde096405
21 changed files with 30 additions and 30 deletions

View File

@ -1,4 +1,4 @@
In addition to the terms of the GNU General Public License, the pyfec package In addition to the terms of the GNU General Public License, the zfec package
also comes with a special added permission that you may delay for up to 12 also comes with a special added permission that you may delay for up to 12
months the fulfillment of your obligation under GPL section 2.b to release any months the fulfillment of your obligation under GPL section 2.b to release any
derived work under this licence. derived work under this licence.

View File

@ -9,13 +9,13 @@ for up to 12 months.
The most widely known example of an erasure code is the RAID-5 algorithm which The most widely known example of an erasure code is the RAID-5 algorithm which
makes it so that in the event of the loss of any one hard drive, the stored makes it so that in the event of the loss of any one hard drive, the stored
data can be completely recovered. The algorithm in the pyfec package has a data can be completely recovered. The algorithm in the zfec package has a
similar effect, but instead of recovering from the loss of only a single similar effect, but instead of recovering from the loss of only a single
element, it can be parameterized to choose in advance the number of elements element, it can be parameterized to choose in advance the number of elements
whose loss it can tolerate. whose loss it can tolerate.
This package is largely based on the old "fec" library by Luigi Rizzo et al., This package is largely based on the old "fec" library by Luigi Rizzo et al.,
which is a mature and optimized implementation of erasure coding. The pyfec which is a mature and optimized implementation of erasure coding. The zfec
package makes several changes from the original "fec" package, including package makes several changes from the original "fec" package, including
addition of the Python API, refactoring of the C API to support zero-copy addition of the Python API, refactoring of the C API to support zero-copy
operation, a few clean-ups and micro-optimizations of the core code itself, operation, a few clean-ups and micro-optimizations of the core code itself,
@ -26,13 +26,13 @@ and the addition of a command-line tool named "fec".
The source is currently available via darcs on the web with the command: The source is currently available via darcs on the web with the command:
darcs get http://www.allmydata.com/source/pyfec darcs get http://www.allmydata.com/source/zfec
More information on darcs is available at http://darcs.net More information on darcs is available at http://darcs.net
Please join the pyfec mailing list and submit patches: Please join the zfec mailing list and submit patches:
<https://postman.allmydata.com/cgi-bin/mailman/listinfo/pyfec> <https://postman.allmydata.com/cgi-bin/mailman/listinfo/zfec>
* Overview * Overview
@ -172,11 +172,11 @@ the fact that the Python API returns references to inputs when possible.
Returning references to its inputs is efficient since it avoids making an Returning references to its inputs is efficient since it avoids making an
unnecessary copy of the data, but if the object which was passed as input is unnecessary copy of the data, but if the object which was passed as input is
mutable and if that object is mutated after the call to pyfec returns, then the mutable and if that object is mutated after the call to zfec returns, then the
result from pyfec -- which is just a reference to that same object -- will also result from zfec -- which is just a reference to that same object -- will also
be mutated. This subtlety is the price you pay for avoiding data copying. If be mutated. This subtlety is the price you pay for avoiding data copying. If
you don't want to have to worry about this then you can simply use immutable you don't want to have to worry about this then you can simply use immutable
objects (e.g. Python strings) to hold the data that you pass to pyfec. objects (e.g. Python strings) to hold the data that you pass to zfec.
* Utilities * Utilities

View File

@ -12,7 +12,7 @@ from fec.util.version import Version
__version__ = Version("1.0.0a1-0-STABLE") __version__ = Version("1.0.0a1-0-STABLE")
if '-V' in sys.argv or '--version' in sys.argv: if '-V' in sys.argv or '--version' in sys.argv:
print "pyfec library version: ", fec.__version__ print "zfec library version: ", fec.__version__
print "fec command-line tool version: ", __version__ print "fec command-line tool version: ", __version__
sys.exit(0) sys.exit(0)

View File

@ -13,7 +13,7 @@ from fec.util.version import Version
__version__ = Version("1.0.0a1-0-STABLE") __version__ = Version("1.0.0a1-0-STABLE")
if '-V' in sys.argv or '--version' in sys.argv: if '-V' in sys.argv or '--version' in sys.argv:
print "pyfec library version: ", fec.__version__ print "zfec library version: ", fec.__version__
print "fec command-line tool version: ", __version__ print "fec command-line tool version: ", __version__
sys.exit(0) sys.exit(0)

View File

@ -1,9 +1,9 @@
""" """
pyfec -- fast forward error correction library with Python interface zfec -- fast forward error correction library with Python interface
maintainer web site: U{http://zooko.com/} maintainer web site: U{http://zooko.com/}
pyfec web site: U{http://www.allmydata.com/source/pyfec} zfec web site: U{http://www.allmydata.com/source/zfec}
""" """
from util.version import Version from util.version import Version
@ -14,7 +14,7 @@ __version__ = Version("1.0.0a1-2-STABLE")
# Please put a URL or other note here which shows where to get the branch of # Please put a URL or other note here which shows where to get the branch of
# development from which this version grew. # development from which this version grew.
__sources__ = ["http://www.allmydata.com/source/pyfec",] __sources__ = ["http://www.allmydata.com/source/zfec",]
from _fec import Encoder, Decoder, Error from _fec import Encoder, Decoder, Error
import filefec import filefec

View File

@ -1,11 +1,11 @@
/** /**
* pyfec -- fast forward error correction library with Python interface * zfec -- fast forward error correction library with Python interface
* *
* Copyright (C) 2007 Allmydata, Inc. * Copyright (C) 2007 Allmydata, Inc.
* Author: Zooko Wilcox-O'Hearn * Author: Zooko Wilcox-O'Hearn
* mailto:zooko@zooko.com * mailto:zooko@zooko.com
* *
* This file is part of pyfec. * This file is part of zfec.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License

View File

@ -1,11 +1,11 @@
/** /**
* pyfec -- fast forward error correction library with Python interface * zfec -- fast forward error correction library with Python interface
* *
* Copyright (C) 2007 Allmydata, Inc. * Copyright (C) 2007 Allmydata, Inc.
* Author: Zooko Wilcox-O'Hearn * Author: Zooko Wilcox-O'Hearn
* mailto:zooko@zooko.com * mailto:zooko@zooko.com
* *
* This file is part of pyfec. * This file is part of zfec.
* *
* This program is free software; you can redistribute it and/or modify it * This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free * under the terms of the GNU General Public License as published by the Free

View File

@ -1,11 +1,11 @@
/** /**
* pyfec -- fast forward error correction library with Python interface * zfec -- fast forward error correction library with Python interface
* *
* Copyright (C) 2007 Allmydata, Inc. * Copyright (C) 2007 Allmydata, Inc.
* Author: Zooko Wilcox-O'Hearn * Author: Zooko Wilcox-O'Hearn
* mailto:zooko@zooko.com * mailto:zooko@zooko.com
* *
* This file is part of pyfec. * This file is part of zfec.
* *
* This program is free software; you can redistribute it and/or modify it * This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free * under the terms of the GNU General Public License as published by the Free

View File

@ -1,10 +1,10 @@
# pyfec -- fast forward error correction library with Python interface # zfec -- fast forward error correction library with Python interface
# #
# Copyright (C) 2007 Allmydata, Inc. # Copyright (C) 2007 Allmydata, Inc.
# Author: Zooko Wilcox-O'Hearn # Author: Zooko Wilcox-O'Hearn
# mailto:zooko@zooko.com # mailto:zooko@zooko.com
# #
# This file is part of pyfec. # This file is part of zfec.
# #
# This program is free software; you can redistribute it and/or modify it # This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free # under the terms of the GNU General Public License as published by the Free

View File

@ -1,10 +1,10 @@
# pyfec -- fast forward error correction library with Python interface # zfec -- fast forward error correction library with Python interface
# #
# Copyright (C) 2007 Allmydata, Inc. # Copyright (C) 2007 Allmydata, Inc.
# Author: Zooko Wilcox-O'Hearn # Author: Zooko Wilcox-O'Hearn
# mailto:zooko@zooko.com # mailto:zooko@zooko.com
# #
# This file is part of pyfec. # This file is part of zfec.
# #
# This program is free software; you can redistribute it and/or modify it under # This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software # the terms of the GNU General Public License as published by the Free Software

View File

@ -3,13 +3,13 @@
# import bindann # import bindann
# import bindann.monkeypatch.all # import bindann.monkeypatch.all
# pyfec -- fast forward error correction library with Python interface # zfec -- fast forward error correction library with Python interface
# #
# Copyright (C) 2007 Allmydata, Inc. # Copyright (C) 2007 Allmydata, Inc.
# Author: Zooko Wilcox-O'Hearn # Author: Zooko Wilcox-O'Hearn
# mailto:zooko@zooko.com # mailto:zooko@zooko.com
# #
# This file is part of pyfec. # This file is part of zfec.
# #
# This program is free software; you can redistribute it and/or modify it under # This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software # the terms of the GNU General Public License as published by the Free Software

View File

@ -1,12 +1,12 @@
#!/usr/bin/env python #!/usr/bin/env python
# pyfec -- fast forward error correction library with Python interface # zfec -- fast forward error correction library with Python interface
# #
# Copyright (C) 2007 Allmydata, Inc. # Copyright (C) 2007 Allmydata, Inc.
# Author: Zooko Wilcox-O'Hearn # Author: Zooko Wilcox-O'Hearn
# mailto:zooko@zooko.com # mailto:zooko@zooko.com
# #
# This file is part of pyfec. # This file is part of zfec.
# #
# This program is free software; you can redistribute it and/or # This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License # modify it under the terms of the GNU General Public License
@ -54,13 +54,13 @@ trove_classifiers=[
"Topic :: System :: Archiving :: Backup", "Topic :: System :: Archiving :: Backup",
] ]
setup(name='pyfec', setup(name='zfec',
version='1.0.0a1', version='1.0.0a1',
summary='Provides a fast C implementation of Reed-Solomon erasure coding with a Python interface.', summary='Provides a fast C implementation of Reed-Solomon erasure coding with a Python interface.',
description='Erasure coding is the generation of redundant blocks of information such that if some blocks are lost ("erased") then the original data can be recovered from the remaining blocks. This package contains an optimized implementation along with a Python interface.', description='Erasure coding is the generation of redundant blocks of information such that if some blocks are lost ("erased") then the original data can be recovered from the remaining blocks. This package contains an optimized implementation along with a Python interface.',
author='Zooko O\'Whielacronx', author='Zooko O\'Whielacronx',
author_email='zooko@zooko.com', author_email='zooko@zooko.com',
url='http://www.allmydata.com/source/pyfec', url='http://www.allmydata.com/source/zfec',
license='GNU GPL', license='GNU GPL',
platform='Any', platform='Any',
packages=['fec', 'fec.util', 'fec.test'], packages=['fec', 'fec.util', 'fec.test'],