Bugtracker supporting distributed revision control
Project description
Bugs Everywhere (BEurtle fork)
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Forked by Niall Douglas http://www.nedprod.com/programs/Win32/BEurtle/
Herein is a fork by me from the master BE GIT repo at http://gitorious.org/be/be.
The main change is that I have patched BE in various ways to make it work better on
Windows. The following may or may not have been incorporated upstream by the time you
read this:
1. Added in a be.bat and be.py as a command
2. Hacked around Windows's inability for parent processes to set the stdin/stdout
charset for child processes by going via environment variables, namely
BE_INPUT_ENCODING and BE_OUTPUT_ENCODING. You can use these to get the BE process
to interpret stdin and stdout as UTF-8 or whatever.
3. Hacked a version generating script (!Generate_version.bat) as most Windows folk
won't have sed and awk kicking around.
4. Made several hacks to enable BE running from within a ZIP archive. This lets you
package up BE into a self contained Windows install which is extremely useful for
BEurtle's purposes. You'll need bbfreeze (easy_install bbfreeze) for the script
!Generate_exe_bbfreeze.py to work, and it will spit out a self-contained directory
into dist.
5. Added be vcs, a thin wrapper for the VCS API in the storage backend. This lets
you talk to the underlying VCS via BE rather than having to write your own VCS
support code. This lets BEurtle drop its VCS support code entirely which is great.
Note that I haven't had any success with getting BE to run under IronPython. It also
crashes out an IronPython compile. Furthermore I haven't got PyInstaller to work, nor
py2exe. You can see their scripts in the notworking directory. Even if you look into
!Generate_exe_bbfreeze.py you'll see extensive hacking of the output because BE is
written in a particular *dynamic* way which prevents correct static analysis, so all
the standard ways of bundling it up fail to include most of BE and its dependencies.
Niall Douglas
February 2012
Bugs Everywhere
===============
This is Bugs Everywhere (BE), a bugtracker built on distributed version
control. It works with Arch, Bazaar, Darcs, Git, Mercurial, and Monotone
at the moment, but is easily extensible. It can also function with no
VCS at all.
The idea is to package the bug information with the source code, so that
bugs can be marked "fixed" in the branches that fix them. So, instead of
numbers, bugs have globally unique ids.
Getting BE
==========
BE is available as a Git repository::
$ git clone git://gitorious.org/be/be.git be
See the homepage_ for details. If you do branch the Git repo, you'll
need to run::
$ make
to build some auto-generated files (e.g. ``libbe/_version.py``), and::
$ make install
to install BE. By default BE will install into your home directory,
but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
to another location.
.. _homepage: http://bugseverywhere.org/
Getting started
===============
To get started, you must set the bugtracker root. Typically, you will want to
set the bug root to your project root, so that Bugs Everywhere works in any
part of your project tree.::
$ be init -r $PROJECT_ROOT
To create bugs, use ``be new $DESCRIPTION``. To comment on bugs, you
can can use ``be comment $BUG_ID``. To close a bug, use
``be close $BUG_ID`` or ``be status $BUG_ID fixed``. For more
commands, see ``be help``. You can also look at the usage examples in
``test_usage.sh``.
Documentation
=============
If ``be help`` isn't scratching your itch, the full documentation is
available in the doc directory as reStructuredText_ . You can build
the full documentation with Sphinx_ , convert single files with
docutils_ , or browse through the doc directory by hand.
doc/index.txt is a good place to start. If you do use Sphinx, you'll
need to install numpydoc_ for automatically generating API
documentation. See the ``NumPy/SciPy documentation guide``_ for an
introduction to the syntax.
.. _reStructuredText:
http://docutils.sourceforge.net/docs/user/rst/quickref.html
.. _Sphinx: http://sphinx.pocoo.org/
.. _docutils: http://docutils.sourceforge.net/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc
.. _NumPy/SciPy documentation guide:
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Forked by Niall Douglas http://www.nedprod.com/programs/Win32/BEurtle/
Herein is a fork by me from the master BE GIT repo at http://gitorious.org/be/be.
The main change is that I have patched BE in various ways to make it work better on
Windows. The following may or may not have been incorporated upstream by the time you
read this:
1. Added in a be.bat and be.py as a command
2. Hacked around Windows's inability for parent processes to set the stdin/stdout
charset for child processes by going via environment variables, namely
BE_INPUT_ENCODING and BE_OUTPUT_ENCODING. You can use these to get the BE process
to interpret stdin and stdout as UTF-8 or whatever.
3. Hacked a version generating script (!Generate_version.bat) as most Windows folk
won't have sed and awk kicking around.
4. Made several hacks to enable BE running from within a ZIP archive. This lets you
package up BE into a self contained Windows install which is extremely useful for
BEurtle's purposes. You'll need bbfreeze (easy_install bbfreeze) for the script
!Generate_exe_bbfreeze.py to work, and it will spit out a self-contained directory
into dist.
5. Added be vcs, a thin wrapper for the VCS API in the storage backend. This lets
you talk to the underlying VCS via BE rather than having to write your own VCS
support code. This lets BEurtle drop its VCS support code entirely which is great.
Note that I haven't had any success with getting BE to run under IronPython. It also
crashes out an IronPython compile. Furthermore I haven't got PyInstaller to work, nor
py2exe. You can see their scripts in the notworking directory. Even if you look into
!Generate_exe_bbfreeze.py you'll see extensive hacking of the output because BE is
written in a particular *dynamic* way which prevents correct static analysis, so all
the standard ways of bundling it up fail to include most of BE and its dependencies.
Niall Douglas
February 2012
Bugs Everywhere
===============
This is Bugs Everywhere (BE), a bugtracker built on distributed version
control. It works with Arch, Bazaar, Darcs, Git, Mercurial, and Monotone
at the moment, but is easily extensible. It can also function with no
VCS at all.
The idea is to package the bug information with the source code, so that
bugs can be marked "fixed" in the branches that fix them. So, instead of
numbers, bugs have globally unique ids.
Getting BE
==========
BE is available as a Git repository::
$ git clone git://gitorious.org/be/be.git be
See the homepage_ for details. If you do branch the Git repo, you'll
need to run::
$ make
to build some auto-generated files (e.g. ``libbe/_version.py``), and::
$ make install
to install BE. By default BE will install into your home directory,
but you can tweak the ``PREFIX`` variable in ``Makefile`` to install
to another location.
.. _homepage: http://bugseverywhere.org/
Getting started
===============
To get started, you must set the bugtracker root. Typically, you will want to
set the bug root to your project root, so that Bugs Everywhere works in any
part of your project tree.::
$ be init -r $PROJECT_ROOT
To create bugs, use ``be new $DESCRIPTION``. To comment on bugs, you
can can use ``be comment $BUG_ID``. To close a bug, use
``be close $BUG_ID`` or ``be status $BUG_ID fixed``. For more
commands, see ``be help``. You can also look at the usage examples in
``test_usage.sh``.
Documentation
=============
If ``be help`` isn't scratching your itch, the full documentation is
available in the doc directory as reStructuredText_ . You can build
the full documentation with Sphinx_ , convert single files with
docutils_ , or browse through the doc directory by hand.
doc/index.txt is a good place to start. If you do use Sphinx, you'll
need to install numpydoc_ for automatically generating API
documentation. See the ``NumPy/SciPy documentation guide``_ for an
introduction to the syntax.
.. _reStructuredText:
http://docutils.sourceforge.net/docs/user/rst/quickref.html
.. _Sphinx: http://sphinx.pocoo.org/
.. _docutils: http://docutils.sourceforge.net/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc
.. _NumPy/SciPy documentation guide:
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
