Tips on PyBuilder

Things under legendu.net/outdated are outdated technologies that the author does not plan to update any more. Please look for better alternatives.

** Things under legendu.net/outdated are outdated technologies that the author does not plan to update any more. Please look for better alternatives. **

Poetry is a better alternative than PyBuilder!

Jump Start a Python 3 Project Using pybuilder

1. Install the Python package venv if you haven't.

   wajig install python3-venv
   

2. Create a directory for your new project (e.g., myproj).

   mkdir myproj
   

3. Change directory to the created directory.

   cd myproj
   

4. Create a new virtual environment.

   python3 -m venv venv
   

5. Activate the virtual environment.

   source venv/bin/activate
   

6. Install pybuilder in the virtual environment.

   pip3 install pybuilder

7. Run the pyb command to initialize your project.

   pyb --start-project

Copy/Install Non-Python Files

from pybuilder.core import use_plugin, init
     
use_plugin("python.core")
use_plugin("python.unittest")
use_plugin("python.install_dependencies")
use_plugin("python.flake8")
use_plugin("python.coverage")
use_plugin("python.distutils")
use_plugin("copy_resources")
     
name = "demo_proj"
version = "0.0.1"
default_task = "publish"
     
     
@init
def set_properties(project):
    project.set_property("coverage_break_build", False)
    project.depends_on_requirements("requirements.txt")
    project.get_property("copy_resources_glob").append("src/main/resources/*.jar")
    project.set_property("copy_resources_target", "$dir_dist")
    project.install_file("share/demo_proj/", "src/main/resources/ojdbc14.jar")
    project.install_file("share/demo_proj/", "src/main/resources/tdgssconfig.jar")
    project.install_file("share/demo_proj/", "src/main/resources/terajdbc4.jar")

https://stackoverflow.com/questions/37409282/pybuilder-non-python-files-are-not-packaged

Integration with PyCharm

http://pybuilder.github.io/documentation/ide.html#.XHngOZNKjRY

https://github.com/pybuilder/pybuilder/issues/24

use pybuilder with pytest

You need to place

use_plugin('pypi:pybuilder_pytest')

and

project.get_property("pytest_extra_args").append("-x")

into the file build.py.

https://github.com/pybuilder/pybuilder/issues/13

Issues with Python 3.7

The current version (0.11.17) of pybuilder does not support Python 3.7. Python 3.7 will be supported by pybuilder starting from version 0.12. If you must use pybuilder with Python 3.7 at this time, you can install the pre-release of pybuilder.

pip3 install --pre pybuilder

References

https://pybuilder.readthedocs.io/en/latest/walkthrough-new.html

http://pybuilder.github.io/documentation/tutorial.html#.XC-5d_x7nmE

https://github.com/pybuilder/pybuilder/issues/606