Initial commit

Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/binario-docs.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/binario-docs.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/binario-docs"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/binario-docs"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6cdda67800eb201b492a763e968565a7
+tags: 645f666f9bcd5a90fca523b33c5a78b7

build/html/_sources/index.txt

@@ -0,0 +1,67 @@
+.. _index-file:
+
+Welcome to binario's documentation!
+========================================
+Package that lets an application read/write primitive data types from an underlying input/output stream as binary data.
+
+Contents
+--------
+* :ref:`what-is-the-binario`
+* :ref:`getting-started`
+* :ref:`writer-docs`
+* :ref:`reader-docs`
+
+.. toctree::
+   :maxdepth: 2
+
+.. _what-is-the-binario:
+
+What is the binario?
+--------------------
+**binario** is the Python package that lets an application read/write primitive data types from an underlying input/output stream as binary data. It can work with booleans, integers, shorts, long integers, floats, doubles, strings and any byte buffers. 
+
+.. _getting-started:
+
+Getting started
+---------------
+First of all, install or upgrade package:
+
+>>> pip install binario
+>>> pip install binario --upgrade
+
+If you want to write data, create instance of `Writer` and then do your work:
+
+>>> import binario
+>>> w = binario.Writer("file.dat")
+>>> w.write_short(2014)
+>>> w.write_bool(True)
+>>> w.write_float(3.1415)
+>>> w.write_string("Hello, world!")
+>>> w.write(bytes([128, 20, 10, 255, 0]))
+
+Also, if you want to read data, do similar things. Like outputting, create `Reader` and then do your work:
+
+>>> import binario
+>>> r = binario.Reader("file.dat")
+>>> r.read_short()
+2014
+>>> r.read_bool()
+True
+>>> r.read_float()
+3.1415
+>>> r.read_string()
+"Hello, world!"
+>>> r.read(5)
+b'\x80\x14\n\xff\x00'
+
+By default **binario** use `network` byte order (or `big-endian`). It is can be changed to `little-endian`:
+
+>>> import binario
+>>> r = binario.Reader("file.dat", binario.LITTLE_ENDIAN)
+>>> w = binario.Writer("another_file.dat", binario.BIG_ENDIAN)
+
+If you want to append new data to existing file, do next:
+
+>>> import binario
+>>> w = binario.Writer("incomplete_file.dat", append=True)
+

build/html/_sources/reader.txt

@@ -0,0 +1,115 @@
+.. _reader-docs:
+
+Class `Reader`
+==============
+Reader lets an application read primitive data types from an underlying input file.
+
+>>> import binario
+>>> r = binario.Reader("file.dat")
+>>> r.read_short()
+2014
+>>> r.read_bool()
+True
+>>> r.read_float()
+3.1415
+>>> r.read_string()
+"Hello, world!"
+>>> r.read(5)
+b'\x80\x14\n\xff\x00'
+
+.. toctree::
+   :maxdepth: 2
+
+__init__(self, file_name, byte_ordering=NETWORK)
+------------------------------------------------
+Create new Reader instance and open file for reading. If it necessary, you can specify byte order - `little-endian` or `big-endian`. By default byte order is `network`(`big-endian`).
+
+>>> import binario
+>>> r_1 = binario.Reader("file_1.dat")
+>>> r_2 = binario.Reader("file_2.dat", binario.LITTLE_ENDIAN)
+
+close(self)
+-----------
+Closes this input file. 
+
+is_closed(self)
+---------------
+Check is input file already closed. 
+
+flush(self)
+-----------
+Flushes this input file. 
+
+get_file(self)
+--------------
+Return current input file. 
+
+get_position(self)
+------------------
+Return count of bytes already taken from the input file. 
+
+get_file_size(self)
+-------------------
+Returns the length of the file. 
+
+is_eof(self)
+------------
+Check is already reached end of file. 
+
+get_remaining_size(self)
+------------------------
+Return remaining count of bytes, available for reading. 
+
+seek(self, pos)
+---------------
+Move to new input file position. If position is negative or out of file, raise Exception. 
+
+read(self, size=1)
+------------------
+Read byte buffer with specified size from input file.
+
+Raise exception in two cases:
+- File already closed.
+- Not enough data to read.
+
+Keyword arguments:
+size -- size of buffer to read (default 1)
+
+>>> import binario
+>>> r = binario.Reader("file.dat")
+>>> r.read(5)
+b'\x80\x14\n\xff\x00'
+
+read_string(self)
+-----------------
+Read string from input file with UTF-8 encoding. 
+
+read_byte(self)
+---------------
+Read byte from input file. 
+
+read_bool(self)
+---------------
+Read boolean from the underlying input file as a 1-byte value. 
+
+read_int(self)
+--------------
+Read signed integer from the underlying input file as a 4-byte value.  
+
+read_short(self)
+----------------
+Read signed short from the underlying input file as a 2-byte value.  
+
+read_long(self)
+---------------
+Read signed long from the underlying input file as a 8-byte value.  
+
+read_float(self)
+----------------
+Read float from the underlying input file as a 4-byte value.  
+
+read_double(self)
+-----------------
+Read double from the underlying input file as a 8-byte value.  
+
+:ref:`index-file`