0.6.0 Package README.md bears no relationship to build schemas of 0.6.0 package. #165

New Issue

claunia · 2026-01-29T20:39:06Z

claunia commented

2026-01-29 20:39:06 +00:00

Originally created by @wrowe on GitHub (Apr 11, 2017).

Quoting;
$ more README.md
To build and run tests, simply do:

$ ./configure && make

If you want to install brotli, use one of the more advanced build systems below.

Bazel

See Bazel

CMake

The basic commands to build, test and install brotli are:

$ mkdir out && cd out && ../configure-cmake && make
$ make test
$ make install

You can use other CMake configuration. For example, to
build static libraries and use a custom installation directory:
^C

$ ls
common dec include MANIFEST.in python setup.cfg tools
CONTRIBUTING.md enc LICENSE PKG-INFO README.md setup.py

Originally created by @wrowe on GitHub (Apr 11, 2017). Quoting; $ more README.md To build and run tests, simply do: $ ./configure && make If you want to install brotli, use one of the more advanced build systems below. #### Bazel See [Bazel](http://www.bazel.build/) #### CMake The basic commands to build, test and install brotli are: $ mkdir out && cd out && ../configure-cmake && make $ make test $ make install You can use other [CMake](https://cmake.org/) configuration. For example, to build static libraries and use a custom installation directory: ^C $ ls common dec include MANIFEST.in python setup.cfg tools CONTRIBUTING.md enc LICENSE PKG-INFO README.md setup.py

claunia closed this issue

2026-01-29 20:39:06 +00:00

claunia commented

2026-01-29 20:39:07 +00:00

@wrowe commented on GitHub (Apr 11, 2017):

Find it especially strange that the Brotli-0.6.0.tar.gz contents seem have significant discrepancies with https://github.com/google/brotli/tree/v0.6

@wrowe commented on GitHub (Apr 11, 2017): Find it especially strange that the Brotli-0.6.0.tar.gz contents seem have significant discrepancies with https://github.com/google/brotli/tree/v0.6

claunia commented

2026-01-29 20:39:07 +00:00

@eustas commented on GitHub (Apr 11, 2017):

It seems to be a wrong name for the file. Actually, sources are for python-module distribution.
We are on the way of splitting it out to brotli-wheels subproject...

Going to make an add full source release artifact, and extend README ASAP.

@eustas commented on GitHub (Apr 11, 2017): It seems to be a wrong name for the file. Actually, sources are for python-module distribution. We are on the way of splitting it out to brotli-wheels subproject... Going to make an add full source release artifact, and extend README ASAP.

claunia commented

2026-01-29 20:39:07 +00:00

@eustas commented on GitHub (Apr 11, 2017):

"Source Code" is the right link. It contains the full copy of repo.
It is overweighted (19MiB), because it contains pdf, images and other garbage.
In next release going to create a distilled version, with no garbage, just sources, meta, and tests.

@eustas commented on GitHub (Apr 11, 2017): "Source Code" is the right link. It contains the full copy of repo. It is overweighted (19MiB), because it contains pdf, images and other garbage. In next release going to create a distilled version, with no garbage, just sources, meta, and tests.

claunia commented

2026-01-29 20:39:08 +00:00

@anthrotype commented on GitHub (Apr 11, 2017):

Yes, as @eustas said, that is the source distribution for the python module. It's generated by the python setup.py sdist command using patterns from the MANIFEST.in file.
Sorry I couldn't find the time to work on the brotli-wheels yet as I promised. I will get to it soon..
The idea is that Travis/Appveyor CI for this repo should no longer do the python packaging and deployment tasks, but only build and run the tests. The other separate repository will use this one as submodule, and upload artifacts to PyPI for distribution.

@anthrotype commented on GitHub (Apr 11, 2017): Yes, as @eustas said, that is the source distribution for the python module. It's generated by the `python setup.py sdist` command using patterns from the `MANIFEST.in` file. Sorry I couldn't find the time to work on the brotli-wheels yet as I promised. I will get to it soon.. The idea is that Travis/Appveyor CI for this repo should no longer do the python packaging and deployment tasks, but only build and run the tests. The other separate repository will use this one as submodule, and upload artifacts to PyPI for distribution.

claunia commented

2026-01-29 20:39:08 +00:00

@wrowe commented on GitHub (Apr 11, 2017):

Thank you anthrotype - yes it is not clear in this list the purpose of Brotli-0.6.0.tar.gz and distinctions between these packages;

Brotli-0.6.0.tar.gz
Brotli-0.6.0.zip
Source code (zip) (v0.6.0.zip)
Source code (tar.gz) (v0.6.0.tar.gz)

Report still applies, that README.md seems not applicable for the first two packages, and works great for the later two (with bonus/unneeded files, but still.) Thanks for looking at this eustas, I can report that the CMAKE flavor has been working well here on master for some time.

@wrowe commented on GitHub (Apr 11, 2017): Thank you anthrotype - yes it is not clear in this list the purpose of Brotli-0.6.0.tar.gz and distinctions between these packages; Brotli-0.6.0.tar.gz Brotli-0.6.0.zip Source code (zip) (v0.6.0.zip) Source code (tar.gz) (v0.6.0.tar.gz) Report still applies, that README.md seems not applicable for the first two packages, and works great for the later two (with bonus/unneeded files, but still.) Thanks for looking at this eustas, I can report that the CMAKE flavor has been working well here on master for some time.

claunia commented

2026-01-29 20:39:08 +00:00

@anthrotype commented on GitHub (Apr 11, 2017):

there is no distinction between Brotli-0.6.0.tar.gz and Brotli-0.6.0.zip; they are both sdist packages, which are meant to be uploaded to the Python Package Index and used by the pip installer, e.g. when one does pip install brotli, and when there are no binary "wheel" packages available for the python version/platform/architecture the user is running.
We shall get rid of those before the next tag, for now you can just ignore them.

@anthrotype commented on GitHub (Apr 11, 2017): there is no distinction between Brotli-0.6.0.tar.gz and Brotli-0.6.0.zip; they are both sdist packages, which are meant to be uploaded to the Python Package Index and used by the `pip` installer, e.g. when one does `pip install brotli`, and when there are no binary "wheel" packages available for the python version/platform/architecture the user is running. We shall get rid of those before the next tag, for now you can just ignore them.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/brotli#165