Repo Setup (DRAFT)

[s2t2]

Reproduce setup instructions on Google machine.

Improve robustness of configuration by implementing environment variables based approach.

(PR currently a work in progress / draft, not ready for merge)

---

FYI - commands used during setup:

poetry add python-dotenv
poetry add jupyter --group dev

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[s2t2]

This SO post references common build problems and recommends removing the version of python installed via venv and re-doing the installation:

deactivate 

pyenv versions

pyenv uninstall 3.11.11

sudo apt-get update
sudo apt-get install libreadline-dev liblzma-dev

sudo apt-get install sqlite3 libsqlite3-dev 
# sudo apt install zlib1g zlib1g-dev libssl-dev libbz2-dev libsqlite3-dev

pyenv install 3.11.11
pyenv global 3.11.11 # may be unnecessary, the previous step seems to have set

source .venv/bin/activate
poetry env activate # is this necessary?
poetry env use 3.11

poetry run python -m ipykernel install --user --name=sbsim-kernel

This resolves the earlier installation issues and we are successfully able to create a kernel 🎉

[s2t2]

Test file template:

"""Tests for [the thing you are testing].

Copyright 2025 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from absl.testing import absltest

# import the function you want to test here

class TestExample(absltest.TestCase):

    def test_example(self):
        self.assertEqual(2+2, 4)


if __name__ == '__main__':
    absltest.main()

[s2t2]

VS Code User Settings (JSON):

{
    "editor.tabSize": 2,
    "editor.detectIndentation": false,
    "files.insertFinalNewline": true,
    "files.trimFinalNewlines": true,
    "files.trimTrailingWhitespace": true,
}

[s2t2]

Makefile (WIP, need to figure out how to make the activation step work (if possible), since they use different shells):

.PHONY: activate_help test lint

VENV_BIN := .venv/bin

#activate_help:
#       @echo "Run: source .venv/bin/activate"
#
#activate:
#       bash -c "source .venv/bin/activate"

# gives permission denied:
#activate:
#       $(VENV_BIN)/activate

test:
        $(VENV_BIN)/pytest --disable-pytest-warnings

lint:
        $(VENV_BIN)/pylint --rcfile=.pylintrc smart_control

https://stackoverflow.com/questions/33839018/activate-virtualenv-in-makefile