Merge branch 'Rename-folder-to-lofar_sid' into 'main'

rename lofar_sid folder

See merge request !2

.gitignore

@@ -15,10 +15,9 @@ docs/source/source_documentation
 docs/build
 
 # Setuptools SCM
-sid/_version.py
+lofar_sid/_version.py
 
 # IDE configuration
 .vscode
 .idea
-sid/interface/*
-
+lofar_sid/interface/*

MANIFEST.in

@@ -3,5 +3,5 @@ include README.md
 
 recursive-include docs *
 recursive-exclude tests *
-recursive-include sid/interface/opah *.py *.pyi
+recursive-include lofar_sid/interface/opah *.py *.pyi
 recursive-include proto *
\ No newline at end of file

README.md

-# sid
+# lofar_sid
 
 This Repo contains the  Following Proto defintions:
 

docs/source/conf.py

@@ -3,7 +3,7 @@
 
 import os
 
-from sid._version import __version__
+from lofar_sid._version import __version__
 
 # -- General configuration ----------------------------------------------------
 
@@ -36,8 +36,8 @@ source_suffix = [".rst"]
 master_doc = "index"
 
 # General information about the project.
-project = "sid"
-copyright = "2023, ASTRON"
+project = "lofar_sid"
+copyright = "2025, ASTRON"
 
 # openstackdocstheme options
 repository_name = "https://git.astron.nl/lofar2.0/sid"

lofar_sid/README.md

+# sid
+
+![Build status](https://git.astron.nl/lofar2.0/sid/badges/main/pipeline.svg)
+![Test coverage](https://git.astron.nl/lofar2.0/sid/badges/main/coverage.svg)
+<!-- ![Latest release](https://git.astron.nl/lofar2.0/sid/badges/main/release.svg) -->
+
+
+## License
+This project is licensed under the Apache License Version 2.0

sid/__init__.py → lofar_sid/__init__.py

 #  Copyright (C) 2025 ASTRON (Netherlands Institute for Radio Astronomy)
 #  SPDX-License-Identifier: Apache-2.0
 
-"""sid"""
+"""lofar_sid"""

sid/contract.py → lofar_sid/contract.py

@@ -6,4 +6,4 @@
 
 def about():
     """Return"""
-    return "This is the SID interface library"
+    return "This is the Lofar SID interface library"

pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-version_file = "sid/_version.py"
+version_file = "lofar_sid/_version.py"
 
 [tool.pylint]
 ignore = "_version.py"

sid/README.md

-# sid
-
-![Build status](https://git.astron.nl/lofar2.0/sid/badges/main/pipeline.svg)
-![Test coverage](https://git.astron.nl/lofar2.0/sid/badges/main/coverage.svg)
-<!-- ![Latest release](https://git.astron.nl/lofar2.0/sid/badges/main/release.svg) -->
-
-Software interface description
-
-## Installation
-```
-pip install .
-```
-
-## Setup
-
-One time template setup should include configuring the docker registry to regularly cleanup old images of
-the CI/CD pipelines. And you can consider creating protected version tags for software releases:
-
-1. [Cleanup Docker Registry Images](https://git.astron.nl/groups/templates/-/wikis/Cleanup-Docker-Registry-Images)
-2. [Setup Protected Verson Tags](https://git.astron.nl/groups/templates/-/wikis/Setting-up-Protected-Version-Tags)
-
-Once the cleanup policy for docker registry is setup you can uncomment the `docker push` comment in the `.gitlab-ci.yml`
-file from the `docker_build` job. This will allow to download minimal docker images with your Python package installed.
-
-## Usage
-```python
-from sid import sid_module
-
-sid_module.version()   # prints version
-```
-
-## Contributing
-
-To contribute, please create a feature branch and a "Draft" merge request.
-Upon completion, the merge request should be marked as ready and a reviewer
-should be assigned.
-
-Verify your changes locally and be sure to add tests. Verifying local
-changes is done through `tox`.
-
-```pip install tox```
-
-With tox the same jobs as run on the CI/CD pipeline can be ran. These
-include unit tests and linting.
-
-```tox```
-
-To automatically apply most suggested linting changes execute:
-
-```tox -e format```
-
-## License
-This project is licensed under the Apache License Version 2.0

tests/test_sid.py

@@ -4,18 +4,18 @@
 """Testing of the Cool Module"""
 from unittest import TestCase
 
-from sid.contract import about
+from lofar_sid.contract import about
 
-from sid.interface.opah.antennafield_pb2 import Antenna_Status
+from lofar_sid.interface.opah.antennafield_pb2 import Antenna_Status
 
 
 class SidModule(TestCase):
-    """Test Case of the Sid  Module"""
+    """Test Case of the Lofar Sid  Module"""
 
     def test_about(self):
         """Testing that the module does  not crash"""
 
-        self.assertEqual(about(), "This is the SID interface library")
+        self.assertEqual(about(), "This is the Lofar SID interface library")
 
     def test_antenna_status(self):
         """Testing that the enums are unique"""

tox.ini

@@ -17,7 +17,7 @@ deps =
 
 commands_pre =
     {envpython} --version
-    {envpython} -m grpc_tools.protoc -Isid/interface=proto --python_out=. --pyi_out=. --grpc_python_out=. proto/opah/observation.proto proto/opah/antennafield.proto proto/opah/grafana-apiv3.proto proto/opah/statistics.proto
+    {envpython} -m grpc_tools.protoc -Ilofar_sid/interface=proto --python_out=. --pyi_out=. --grpc_python_out=. proto/opah/observation.proto proto/opah/antennafield.proto proto/opah/grafana-apiv3.proto proto/opah/statistics.proto
 
 
 commands =
@@ -27,7 +27,7 @@ commands =
 [testenv:coverage]
 commands =
     {envpython} --version
-    {envpython} -m pytest --cov-report term --cov-report xml --cov-report html --cov=sid tests/{posargs}
+    {envpython} -m pytest --cov-report term --cov-report xml --cov-report html --cov=lofar_sid tests/{posargs}
 
 # Use generative name and command prefixes to reuse the same virtualenv
 # for all linting jobs.
@@ -37,14 +37,14 @@ package = editable
 envdir = {toxworkdir}/linting
 commands =
     pep8: {envpython} -m flake8 --version
-    pep8: {envpython} -m flake8  --exclude=sid/interface sid tests
+    pep8: {envpython} -m flake8  --exclude=lofar_sid/interface lofar_sid tests
     black: {envpython} -m black --version  
-    black: {envpython} -m black --check --diff sid tests  --exclude '.*pb2.*\.py|_version\.py' 
+    black: {envpython} -m black --check --diff lofar_sid tests  --exclude '.*pb2.*\.py|_version\.py' 
     pylint: {envpython} -m pylint --version
-    pylint: {envpython} -m pylint  --prefer-stub=true sid tests 
-    format: {envpython} -m autopep8 -v -aa --in-place --recursive sid
+    pylint: {envpython} -m pylint  --prefer-stub=true lofar_sid tests 
+    format: {envpython} -m autopep8 -v -aa --in-place --recursive lofar_sid
     format: {envpython} -m autopep8 -v -aa --in-place --recursive tests
-    format: {envpython} -m black -v sid tests
+    format: {envpython} -m black -v lofar_sid tests
 
 [testenv:docs]
 ; unset LC_ALL / LANGUAGE from testenv, would fail sphinx otherwise