Skip to content

Commit fcd3b13

Browse files
authored
Adding some documentation
1 parent d2708a6 commit fcd3b13

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

docs/shipping/freezing.rst

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,46 @@ bbFreeze
7070

7171
Prerequisite is to install :ref:`Python, Setuptools and pywin32 dependency on Windows <install-windows>`.
7272

73+
1. Install :code:`bbfreeze`:
74+
75+
.. code-block:: console
76+
77+
$ pip install bbfreeze
78+
79+
2. Write most basic :file:`bb_setup.py`
80+
7381
.. code-block:: python
7482
7583
from bbfreeze import Freezer
7684
77-
freezer = Freezer('script')
78-
freezer.addScript('foobar.py')
85+
freezer = Freezer(distdir='dist')
86+
freezer.addScript('foobar.py', gui_only=True)
7987
freezer()
88+
89+
.. note::
90+
91+
This will work for the most basic one file scripts. For more advanced freezing you will have to provide
92+
include and exclude paths like so
93+
94+
.. code-block:: python
95+
96+
freezer = Freezer(distdir='dist', includes=['my_code'], excludes=['docs'])
97+
98+
3. (Optionally) include icon
99+
100+
.. code-block:: python
101+
102+
freezer.setIcon('my_awesome_icon.ico')
103+
104+
4. Provide the Microsoft Visual C runtime DLL for the freezer. It might be possible to append your :code:`sys.path`
105+
with Microsoft Visual Studio path but I find it easier to drop :file:`msvcp90.dll` in the same folder where your script
106+
resides.
107+
108+
5. Freeze!
109+
110+
.. code-block:: console
111+
112+
$ python bb_setup.py
80113
81114
py2exe
82115
~~~~~~

0 commit comments

Comments
 (0)