OpenFabrics / sunfish_library_reference

The core Sunfish implementation
BSD 3-Clause "New" or "Revised" License
2 stars 4 forks source link

Rename source directory #8

Closed dledford closed 6 months ago

dledford commented 6 months ago

Redundant names create overly long names. Rename directories in order to keep overall path names more reasonable in length and avoid redundencies in the pathname. Update the tests to accommodate these changes.

christian-pinto commented 6 months ago

I'm fine with the renaming. Christian - can you expand on what you mean by "when we pip install the library and include it into another project I would avoid having to write src"? How much of a burden is it to do that?

Apologies for being brief. I have no laptop and doing the review from my phone.

Let's say we build a REST server for sunfish. With this structure we do not needed to have the sunfish code together with the REST server code. The only thing one would do is to have the reference library as requirement and from the REST server code just import and initialize the sunfish library.

The best would be that once the sunfish library is installed, one would use it by just importing it.

The best form is to have something like

from sunfish.core import X

Having to write src is not only annoying but could also conflict with other dependencies, or the python modules of the current project if it includes src.

I hope this is clearer.

Christian

dledford commented 6 months ago

Forced update pushed to the branch. Rename changed to be:

sunfish.lib sunfish.storage sunfish.events

The intent is sunfish.agent will be a thing, and sunfish.server will be a thing, and if they all get imported into the same project they don't clash.

On Fri, Dec 8, 2023 at 1:04 PM Christian Pinto @.***> wrote:

I'm fine with the renaming. Christian - can you expand on what you mean by "when we pip install the library and include it into another project I would avoid having to write src"? How much of a burden is it to do that?

Apologies for being brief. I have no laptop and doing the review from my phone.

Let's say we build a REST server for sunfish. With this structure we do not needed to have the sunfish code together with the REST server code. The only thing one would do is to have the reference library as requirement and from the REST server code just import and initialize the sunfish library.

The best would be that once the sunfish library is installed, one would use it by just importing it.

The best form is to have something like

from sunfish.core import X

Having to write src is not only annoying but could also conflict with other dependencies, or the python modules of the current project if it includes src.

I hope this is clearer.

Christian

— Reply to this email directly, view it on GitHub https://github.com/OpenFabrics/sunfish_library_reference/pull/8#issuecomment-1847605351, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIFQFJ2XLHP6K6SVGFZCYLYINJDFAVCNFSM6AAAAABAM2MGQSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBXGYYDKMZVGE . You are receiving this because you were assigned.Message ID: @.***>

-- Doug Ledford @.***> GPG KeyID: B826A3330E572FDD Key fingerprint = AE6B 1BDA 122B 23B4 265B 1274 B826 A333 0E57 2FDD

christian-pinto commented 6 months ago

LGTM!