How to Contribute

The code repository is hosted on GitHub. To contribute fixes, code, or documentation, fork the repository and submit changes using a pull request against the master branch.

Set Up Your Environment

We recommend developing within a virtual environment. The following installation is recommended within the virtual environment:

$ git clone <url to forked repo> structuralglass
$ cd structuralglass
$ pip install -e .[dev]

Using the dev option will add additional dependencies for development, such as Sphinx, flake8, black, and isort.

If distribution dependencies are needed add the dist option:

$ pip install -e .[dev,dist]

Testing

The test suite can be run with:

$ python -m unittest test.unittests